Maven SpringCloud项目多模块构建

Maven SpringCloud项目多模块构建

我为什么要用多模块构建SpringCloud

在项目构建过程中，尤其是现在微服务的流行，很多项目将业务模块化。如果不使用Maven模块化仅仅在同一目录下创建多个子SpringCloud项目也相当于模块化。但进行Maven多模块构建为达到项目解耦和项目水平分层的目的，有以下两个原因说明：

• 项目中存在个人创建的公共代码，如加密工具、Http请求工具等，如果没有把这些封装成子项目，就必须在每个用到子项目中使用到公共代码放到该项目中，这样做耦合度高，因此将这些公共部分抽取成公共模块，子项目再去引用该模块,已到达降低耦合度的目的。
• SpringCloud项目中，开发业务时又进行水平分层，往往分为Dao层，Service层和视图层，如果是大型项目，各层也是由不同开发人员进行开发，各层调用下层接口为上层提供服务接口，为达到解耦目的，在子项目中也将各层Maven模块化。子项目是否模块化分层也要看情况而定。

一、项目目录结构

backend
│   pom.xml     //backend父项目的pom.xml文件
└───backend-common
│   │   pom.xml   //backend-common子项目的pom.xml文件
│   └───src
│       │   
│       └───main
│   
└───rest-api
│   │   pom.xml  //rest-api子项目的pom.xml文件
│   └───src
│       │   
│       └───main

二、backend父项目的pom.xml文件配置

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">


    <!-- 基本信息 -->
    <modelVersion>4.0.0</modelVersion>
    <name>backend</name>
    <description>Demo project for Spring Boot</description>
    <packaging>pom</packaging>

    <!-- 项目说明：这里作为聚合工程的父工程 -->
    <groupId>com.kyrioscraft.cloud</groupId>
    <artifactId>backend</artifactId>
    <version>1.0</version>

    <!-- 常量配置 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Greenwich.M3</spring-cloud.version>
    </properties>

    <!-- 继承说明：这里继承SpringBoot提供的父工程 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <modules>
        <module>ribbon-rest</module>
        <module>backend-common</module>
    </modules>

    <!--指定依赖>
    <dependencies>

        <!-- 集成lombok 框架 -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!-- 集成web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- 集成aop -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>
    
    <!-- 父项目构建 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-surefire-plugin</artifactId>
                <configuration>
                    <skipTests>true</skipTests>    <!--默认关掉单元测试 -->
                </configuration>
            </plugin>
        </plugins>
    </build>

</project>

• 父项目不需要打包成jar，指定packing为pom
• 父项目打包用到的是maven-compiler-plugin而不是spring-boot-maven-plugin，这样才能把公共模块的打包到引用公共模块的项目中

三、backend-common公共模块子项目的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">

    <!--指明父模块-->
    <parent>
        <artifactId>backend</artifactId>
        <groupId>com.kyrioscraft.cloud</groupId>
        <version>1.0</version>
    </parent>

    <!--模块信息，不生成jar，war的没有packing-->
    <modelVersion>4.0.0</modelVersion>
    <version>1.0</version>
    <artifactId>backend-common</artifactId>

    <!--依赖-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

</project>

• 不打包不配置packing
• 项目中用到了@Servcie，@Controller注解的一定要添加相关的依赖，不然会报错，即使在父项目中配置过相关的依赖

四、rest-api子项目的pom.xml文件

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>

    <!--项目信息-->
	<groupId>com.kyrioscraft.cloud</groupId>
	<artifactId>rest-api</artifactId>
	<version>1.0</version>
	<packaging>jar</packaging>

	<name>rest-api</name>
	<description>Demo project for Spring Boot</description>

    <!--父项目-->
	<parent>
		<groupId>com.kyrioscraft.cloud</groupId>
		<artifactId>backend</artifactId>
		<version>1.0</version>
	</parent>

	<properties>
		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
		<java.version>1.8</java.version>
	</properties>
	
    <!--依赖-->
	<dependencies>
	
	    <!--引入backend-common子模块-->
		<dependency>
			<groupId>com.kyrioscraft.cloud</groupId>
			<artifactId>backend-common</artifactId>
			<version>1.0</version>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
		</dependency>
		<dependency>
			<groupId>org.springframework.cloud</groupId>
			<artifactId>spring-cloud-starter-netflix-ribbon</artifactId>
		</dependency>
	</dependencies>
	
    <!--项目打包插件-->
	<build>
		<plugins>
			<plugin>
				<groupId>org.springframework.boot</groupId>
				<artifactId>spring-boot-maven-plugin</artifactId>
			</plugin>
		</plugins>
	</build>

</project>

• jar方式打包，该项目提供rest接口
• 打包插件spring-boot-maven-plugin，要在对应模块中添加该插件
• 在dependencies引入公共模块backend-common
• backend-common项目中使用了@Servcie,@Component注入bean时，调用组件一定要配置bean的包，@ComponentScan(basePackages = “com.kyrioscraft.cloud”)

五、项目打包

项目打包要注意一定要在父项目下执行maven打包，也就是在backend下打包。