创建一个基于Spring IO Platform的多模块Gradle项目

简介: 最近有同学问我,能不能让我弄一个基于Spring-Platform的多模块Gradle项目的例子,最近终于试着弄了一下,所以写篇文章介绍一下。首先介绍一下Spring IO Platform,它主要为了帮助我们管理项目中庞大的类库的版本。

最近有同学问我,能不能让我弄一个基于Spring-Platform的多模块Gradle项目的例子,最近终于试着弄了一下,所以写篇文章介绍一下。

首先介绍一下Spring IO Platform,它主要为了帮助我们管理项目中庞大的类库的版本。做过项目的同学都肯定被大量类库的版本号所困扰,如果要进行项目升级的话一堆类库要不要进行升级,升级会不会出现不兼容情况?如果使用Spring IO Platform的话,它会帮我们统一管理这些版本,Spring IO Platform一升级,所有相关类库版本都会升级,而且Spring IO Platform会保证它们之间的兼容性。我之前也写过一篇文章《Spring IO Platform 简介》介绍Spring IO Platform。

Gradle的话大家可能不太熟悉,但是我是非常喜欢使用Gradle,因为确实比Maven好用多了,不过之前都是单个的简单Gradle项目,正好我也没试过多模块互相依赖的Gradle,正好也来研究一下。

创建项目

创建父项目

首先打开Idea,创建一个空的Gradle项目。父项目是之后两个子项目的容器,父项目本身没有任何代码,所以这里什么也不需要选。

img_d8abf34edc003624588dcbc4d5d1dfdc.png
创建父项目

创建完成后在build.gradle中添加以下代码:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'io.spring.gradle:dependency-management-plugin:1.0.0.RELEASE'
    }
}
apply plugin: 'io.spring.dependency-management'

repositories {
    mavenCentral()
}

dependencyManagement {
    imports {
        mavenBom 'io.spring.platform:platform-bom:Cairo-SR4'
    }
}

这些代码导入了Spring IO Platform插件,让Spring IO Platform来管理项目依赖。有了这些代码,之后的依赖项就不需要手动指定版本好了。

创建booklist子模块

然后来创建两个子项目。首先在Idea中选中项目窗格中选中父项目,然后点击File->New-Module...,来创建一个名为booklist的子项目,类库那里只选择Java。如果前面不选择父项目,那么Idea只会创建一个独立的模块,而非我们想要的Gradle子模块。

编辑一下build.gradle文件,将版本号删掉。

plugins {
    id 'java'
}

group 'yitian.study'
version '1.0-SNAPSHOT'

sourceCompatibility = 1.8

repositories {
    mavenCentral()
}

dependencies {
    testCompile group: 'junit', name: 'junit'
}

然后在booklist模块中,我们随便写点东西,比方说我就写了这么两个文件:

// IBookList接口
package yitian.study.booklist;

import java.util.List;

public interface IBookList {
    List<String> getBookList();
}

// MyBookList实现类
package yitian.study.booklist;

import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class MyBookList implements IBookList {

    @Override
    public List<String> getBookList() {
        return Stream.of("金瓶梅", "少年阿宾", "少妇白洁")
                .collect(Collectors.toList());
    }
}

创建webapp子模块

这个模块是一个基于Spring Boot的webapp项目,用来显示刚才的booklist。按照同样的方法创建子模块webapp,然后在build.gradle中添加以下内容:

plugins {
    id 'org.springframework.boot' version '2.0.5.RELEASE'
    id 'java'
}


jar {
    baseName = 'mywebapp'
    version = '0.0.1-SNAPSHOT'
}

repositories {
    jcenter()
}

dependencies {
    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-devtools")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

创建完毕后,查看一下父项目的settings.gradle文件,应该会看到类似下面的内容,被包括的正是两个子模块。如果没有包括类似的内容, 说明创建子模块的时候没选中父项目,导致Idea不能自动生成这些gradle配置。

rootProject.name = 'multi-module-spring-platform-webapp-sample'
include 'booklist'
include 'webapp'

配置依赖关系

这时候,打开Idea的Gradle窗格,应该会看到一片红色:


img_b8800d20475ef25fe7708c580e69b232.png
未处理好的依赖关系

如果全部展开的话,会发现所有类库都是解析失败的状态(Unable to resolve),这说明我们前面配置的有问题。其实,这和Gradle多模块的依赖实现有关系。默认情况下,每个模块的build.gradle的作用域只有本模块自身,也就是说,我们前面配置的Spring IO Platform父项目只能管理自己的依赖,这些设置无法作用到子模块上。

配置全局依赖

如果要让所有子模块共享依赖,需要在父项目中配置allprojects部分,这一部分会在所有子模块中共享。编辑父项目的build.gradle文件,改成下面这样的。这样一来,Spring IO Platform就可以管理所有子项目的依赖了。

group 'yitian.study'
version '1.0-SNAPSHOT'

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath 'io.spring.gradle:dependency-management-plugin:1.0.0.RELEASE'
    }
}

allprojects {
    apply plugin: 'io.spring.dependency-management'

    repositories {
        mavenCentral()
    }

    dependencyManagement {
        imports {
            mavenBom 'io.spring.platform:platform-bom:Cairo-SR4'
        }
    }
}

如果再观察一下Idea的Gradle窗格,会发现这时候就没有那些红色波浪线了。

配置模块间依赖

子模块之间也可能存在依赖关系,比方说前面创建的webapp模块要显示booklist内容,那么webapp肯定要依赖booklist。所以需要在webapp的build.gradle中进行一些修改:

dependencies {
    // 引用另一个模块booklist
    compile project(':booklist')

    compile("org.springframework.boot:spring-boot-starter-web")
    compile("org.springframework.boot:spring-boot-starter-thymeleaf")
    compile("org.springframework.boot:spring-boot-devtools")
    testCompile("org.springframework.boot:spring-boot-starter-test")
}

这样一来,在webapp子模块中,也可以访问booklist子模块中的booklist包以及其中的代码了。

// WebApplication.java
package yitian.study;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import yitian.study.booklist.IBookList;
import yitian.study.booklist.MyBookList;

@SpringBootApplication
public class WebApplication {
    public static void main(String[] args) {
        SpringApplication.run(WebApplication.class, args);
    }

    @Bean
    public IBookList myBookList() {
        return new MyBookList();
    }
}

// MainController.java
package yitian.study.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import yitian.study.booklist.IBookList;

@Controller
public class MainController {
    @Autowired
    private IBookList myBookList;

    @RequestMapping("/")
    String index(Model model) {
        model.addAttribute("booklist",myBookList.getBookList());
        return "index";
    }
}

最终项目结构如图所示。

img_4e3c0acdc72f4fb34a6e99b91fe77fae.png
项目结构

还有一些Thymeleaf的代码我就不贴了,直接看一下webapp显示即可。

img_53429f3450d8bdac3f7584636959fa29.png
最终效果

以上就是一个简单的基于Spring IO Platform的多模块Gradle项目示例,向大家简单介绍一下Gradle多模块项目的用法,希望对大家有所帮助。项目已经上传到Github,有兴趣的同学可以看看。

相关文章
|
1月前
|
存储 运维 安全
Spring运维之boot项目多环境(yaml 多文件 proerties)及分组管理与开发控制
通过以上措施,可以保证Spring Boot项目的配置管理在专业水准上,并且易于维护和管理,符合搜索引擎收录标准。
43 2
|
2月前
|
设计模式 前端开发 Java
Spring MVC——项目创建和建立请求连接
MVC是一种软件架构设计模式,将应用分为模型、视图和控制器三部分。Spring MVC是基于MVC模式的Web框架,通过`@RequestMapping`等注解实现URL路由映射,支持GET和POST请求,并可传递参数。创建Spring MVC项目与Spring Boot类似,使用`@RestController`注解标记控制器类。
47 1
Spring MVC——项目创建和建立请求连接
|
2月前
|
Java 关系型数据库 MySQL
Maven——创建 Spring Boot项目
Maven 是一个项目管理工具,通过配置 `pom.xml` 文件自动获取所需的 jar 包,简化了项目的构建和管理过程。其核心功能包括项目构建和依赖管理,支持创建、编译、测试、打包和发布项目。Maven 仓库分为本地仓库和远程仓库,远程仓库包括中央仓库、私服和其他公共库。此外,文档还介绍了如何创建第一个 SpringBoot 项目并实现简单的 HTTP 请求响应。
182 1
Maven——创建 Spring Boot项目
|
2月前
|
Java 关系型数据库 MySQL
如何使用 maven 创建一个 Spring Boot项目
Maven 是一个强大的项目管理工具,通过配置 `pom.xml` 文件自动获取所需的 jar 包,提高开发效率。其核心功能包括项目构建和依赖管理。项目构建支持编译、测试、打包和发布等流程,而依赖管理则通过中央仓库、本地仓库和私有服务器获取和管理项目依赖。示例中展示了如何创建第一个 SpringBoot 项目并实现简单接口。
53 1
如何使用 maven 创建一个 Spring Boot项目
|
2月前
|
Java Apache Maven
Java/Spring项目的包开头为什么是com?
本文介绍了 Maven 项目的初始结构,并详细解释了 Java 包命名惯例中的域名反转规则。通过域名反转(如 `com.example`),可以确保包名的唯一性,避免命名冲突,提高代码的可读性和逻辑分层。文章还讨论了域名反转的好处,包括避免命名冲突、全球唯一性、提高代码可读性和逻辑分层。最后,作者提出了一个关于包名的问题,引发读者思考。
Java/Spring项目的包开头为什么是com?
|
Java Maven Spring
Spring IO Platform 简介
Spring IO Platform框架简单来说就是一个版本号兼容系统,它将常用第三方类库的兼容的版本组织起来。只要我们在项目中引用了Spring IO Platform,就不需要为这些第三方类库设置版本号了,Spring IO Platform会自动帮我们设置所有兼容的版本号。
1444 0
|
2月前
|
人工智能 自然语言处理 前端开发
SpringBoot + 通义千问 + 自定义React组件:支持EventStream数据解析的技术实践
【10月更文挑战第7天】在现代Web开发中,集成多种技术栈以实现复杂的功能需求已成为常态。本文将详细介绍如何使用SpringBoot作为后端框架,结合阿里巴巴的通义千问(一个强大的自然语言处理服务),并通过自定义React组件来支持服务器发送事件(SSE, Server-Sent Events)的EventStream数据解析。这一组合不仅能够实现高效的实时通信,还能利用AI技术提升用户体验。
239 2
|
1天前
|
Java 数据库连接 Maven
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
自动装配是现在面试中常考的一道面试题。本文基于最新的 SpringBoot 3.3.3 版本的源码来分析自动装配的原理,并在文未说明了SpringBoot2和SpringBoot3的自动装配源码中区别,以及面试回答的拿分核心话术。
最新版 | 深入剖析SpringBoot3源码——分析自动装配原理(面试常考)
|
8天前
|
NoSQL Java Redis
Spring Boot 自动配置机制:从原理到自定义
Spring Boot 的自动配置机制通过 `spring.factories` 文件和 `@EnableAutoConfiguration` 注解,根据类路径中的依赖和条件注解自动配置所需的 Bean,大大简化了开发过程。本文深入探讨了自动配置的原理、条件化配置、自定义自动配置以及实际应用案例,帮助开发者更好地理解和利用这一强大特性。
52 14
|
1月前
|
缓存 IDE Java
SpringBoot入门(7)- 配置热部署devtools工具
SpringBoot入门(7)- 配置热部署devtools工具
49 1
SpringBoot入门(7)- 配置热部署devtools工具