SpringBoot+Gradle构建多模块项目
1 概述
Gradle
由于构建速度比Maven
快,且比Maven
灵活,因此很多后端的应用都使用了Gradle
进行构建,但一个问题是,Gradle
的多模块项目比较难构建,再加上Gradle
的更新非常快,这就给构建一个多模块Gradle
项目造成了不少的困难。
基于此出发点,本文提供了两种形式的使用Gradle
构建的Spring Boot
多模块项目:
Java + Gradle
Kotlin + Gradle + Kotlin DSL
为了减少出现各种错误的概率,步骤做得非常详细(多图预警),文末也附上了源码,下面就一起来看看吧。
2 环境
Gradle 7.4
Spring Boot 2.6.4
Kotlin 1.6.10
OpenJDK 17
3 Java + Gradle
主要步骤:
- 使用
Spring Initializer
创建项目 - 修改
build.gradle
- 创建模块
- 编写模块
- 运行
- 测试
3.1 创建项目
直接使用IDEA
提供的Spring Initializer
即可,构建工具选择Gradle
:
依赖:
构建完成后删除src
目录,因为根目录属于管理模块目录不提供运行的应用:
3.2 修改build.gradle
这是最复杂的一步,并且Gradle
版本更新的话步骤可能会不一样,首先在底部添加一个空的subprojects
:
接着把dependencies
以及tasks.name('test')
移动进去:
最后一步是,在subprojects
开头,添加插件apply
,根据默认初始化创建的plugins
,逐一添加。
比如这里默认使用了三个插件:
apply
到subprojects
中:
3.3 创建模块
File -> New -> Module
:
输入模块名即可,这里的例子是创建两个模块:
service
app
创建好后如图所示:
完成创建之后,把两个模块中的build.gradle
除了repositories
之外的全部删去,仅保留repositories
:
3.4 编写模块
3.4.1 service
模块
首先创建包,根据根目录中的build.gradle
中的group
创建:
接着编写一个叫TestService
的带@Service
注解的类,里面包含一个test
方法:
同时修改service
模块的build.gradle
,添加bootJar
以及jar
选项:
bootJar{
enabled = false
}
jar{
enabled = true
}
3.4.2 app
模块
同样先创建包:
接着在app
模块的build.gradle
添加service
模块的依赖:
再创建启动类以及一个Controller
:
代码如下:
package com.example.app;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication(scanBasePackages = "com.example")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class,args);
}
}
package com.example.controller;
import com.example.service.TestService;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class TestController {
private final TestService service;
@GetMapping("/test")
public String test(){
return service.test();
}
}
注意,因为Spring Boot
无法自动识别其他模块下的类,所以需要手动处理一下,有三种方法:
- 第一种:使用
@Import
,也就是@Import(TestService.class)
- 第二种:使用
scanBasePackageClasses
,也就是@SpringBootApplication(scanBasePackageClasses={TestService.class})
- 第三种:使用
scanBasePackages
,也就是例子中的代码@SpringBootApplication(scanBasePackages = "com.example")
3.5 运行
接下来就可以运行了,可以直接点击Application
旁边的绿色小三角:
或者从运行配置中选择Application
运行(IDEA
自动创建的,原来的那个JavaGradleApplication
带一个×是因为启动文件已经删除了,可以顺便把该配置删除):
没问题的话就可以成功运行了:
同时浏览器访问localhost:8080/test
会出现test
字样:
3.6 测试
创建包和测试类:
package com.example.test;
import com.example.service.TestService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest(classes = TestService.class) //需要引入对应的类
public class JavaGradleTest {
@Autowired
private TestService service;
@Test
public void test() {
System.out.println(service.test());
}
}
接着进行测试:
当然测试也可以跑一下Gradle
中的任务:
3.7 打包
打包的话直接运行bootJar
即可:
会在build/libs
下生成JAR
包:
测试:
再次访问localhost:8080/test
没有问题。
这样使用Java
+Gradle
构建一个多模块的Spring Boot
项目就成功了。
4 Kotlin + Gradle + Kotlin DSL
Kotlin DSL
在原生Gradle
(Groovy DSL
)的基础上进行改进,但同时语法也变得更加陌生,难度因此也加大了不少,不过这并没有难倒笔者。构建多模块的基本步骤与上面类似:
- 使用
Spring Initializer
创建项目 - 修改
build.gradle.kts
- 创建模块
- 编写模块
- 运行
- 测试
4.1 创建项目
选择Kotlin
+Gradle
:
依赖:
同样删除src
:
4.2 修改build.gradle.kts
同样在尾部添加一个空的subprojects
:
把dependencies
以及tasks
移动进去:
最后在subprojects
开始处apply
插件,根据默认的插件进行apply
:
代码如下:
apply{
plugin("org.springframework.boot")
plugin("io.spring.dependency-management")
plugin("org.jetbrains.kotlin.jvm")
plugin("org.jetbrains.kotlin.plugin.spring")
}
plugins
中的kotlin
是org.jetbrains.kotlin
的简写,在subprjects
中注意加上即可。
4.3 创建模块
File -> New -> Module
,把一些必要选项勾选上:
这里同样创建两个模块:
service
app
同样把两个模块中的build.gradle.kts
删除其他部分留下repositories
:
4.4 编写模块
4.4.1 service
模块
首先根据根目录的build.gradle.kts
创建包:
编写TestService
:
最后修改build.gradle.kts
,加上tasks.bootJar
与tasks.jar
:
tasks.bootJar{
enabled = false
}
tasks.jar{
enabled = true
}
4.4.2 app
模块
先创建包:
添加对service
模块的依赖:
再创建一个启动类以及一个Controller
:
代码如下:
package com.example.app
import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
@SpringBootApplication(scanBasePackages = ["com.example"])
class Application
fun main(args:Array<String>) {
SpringApplication.run(Application::class.java,*args)
}
package com.example.app.controller
import com.example.service.TestService
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.RestController
@RestController
class TestController {
@Autowired
lateinit var service: TestService
@GetMapping("/test")
fun test() = service.test()
}
4.5 运行
点击main
旁边的绿色小三角即可:
运行成功:
同样可以访问localhost:8080/test
:
4.6 测试
创建包与测试类:
package com.example.test
import com.example.service.TestService
import org.junit.jupiter.api.Test
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.boot.test.context.SpringBootTest
@SpringBootTest(classes = [TestService::class])
class KotlinTest {
@Autowired
lateinit var service: TestService
@Test
fun test() {
println(service.test())
}
}
直接点击小三角测试即可:
测试通过。
4.7 打包
bootJar
即可:
同样会在libs
下生成JAR
:
运行测试后没有问题,这样Kotlin+Gradle+Kotlin DSL
的多模块Spring Boot
项目就算创建完成了。
5 源码
附上两个例子的源码: