Spring-cloud: 项目分包策略

最新推荐文章于 2025-02-01 13:30:15 发布

Qhearts

最新推荐文章于 2025-02-01 13:30:15 发布

阅读量2.5k

点赞数

分类专栏： Spring Cloud

本文链接：https://blog.youkuaiyun.com/u012546203/article/details/81564040

版权

Spring Cloud 专栏收录该内容

5 篇文章

订阅专栏

本文介绍了在Spring Cloud项目中，为了避免代码重复和便于管理，采用分包策略的方法。通过创建Maven模块，如dmp-support-dms、dms-common和dms-server，将对象分隔开。详细步骤包括删除不必要的文件，保留pom.xml，并创建子模块。通过引入相应包，可以实现接口的扫描和自动注入，避免复制实体对象和编写Feign接口。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用到的工具：Interlij IDEA、processon

在搭建一个Spring-Cloud项目的时候，通过第三方的 Feign 的 RestTemplate 的过程中，在 Server端的对象总是会 copy 到别的项目中，使代码重复，不适于管理，通过分包的方式来解决这一问题：

具体实现过程：

1. 创建一个 maven 模块

删除掉 src等只保留pom.xml

dmp-support-dms\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.jlc.dmp</groupId>
    <artifactId>dmp-support-dms</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>pom</packaging>

    <name>dmp-support-dms</name>
    <description>dms database mongodb</description>

    <modules>
        <module>dms-common</module><!-- common:pojo -->
        <module>dms-server</module><!-- server -->
        <module>dms-client</module><!-- client: feign interface -->
    </modules>
    

    <parent><!-- extends spring-boot -->
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.1.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <!-- properties -->
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>

        <!-- jar version -->
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
        <spring-cloud-consul.version>2.0.2.BUILD-SNAPSHOT</spring-cloud-consul.version>
        
        <!-- inner dependency jar version -->
        <dms-common.version>0.0.1-SNAPSHOT</dms-common.version>
    </properties>

    <!-- Dependency Management -->
    <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>

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

            <dependency>
                <groupId>com.jlc.dmp</groupId>
                <artifactId>dms-common</artifactId>
                <version>${dms-common.version}</version>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>https://repo.spring.io/libs-snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
    </repositories>


</project>

创建子模块 dms-common:

dms-common\pom.xml

<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>

    <parent><!-- extends dmp-support-dms -->
        <groupId>com.jlc.dmp</groupId>
        <artifactId>dmp-support-dms</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>
    
    <!-- maven id -->
    <artifactId>dms-common</artifactId>
    <name>dms-common</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <!-- optional=true, Dependence does not pass -->
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

创建子模块 dms-client: 与创建dms-common类似

创建dms-server:

dms-server\pom.xml

<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>

    <parent>
        <groupId>com.jlc.dmp</groupId>
        <artifactId>dmp-support-dms</artifactId>
        <version>0.0.1-SNAPSHOT</version>
    </parent>

    <artifactId>dms-server</artifactId>
    <name>dms-server</name>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <!-- consul discovery components -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-consul-discovery</artifactId>
        </dependency>

        <!-- Web starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-mongodb</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <!-- optional=true, Dependence does not pass -->
            <optional>true</optional>
        </dependency>

        <!-- inner module -->
        <dependency>
            <groupId>com.jlc.dmp</groupId>
            <artifactId>dms-common</artifactId>
        </dependency>

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

    </dependencies>

    <!-- Spring-boot's Maven plugin -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <!-- 打成jar 在 java -jar 启动方式的时候需要 main 方法 -->
                    <mainClass>com.jlc.dmp.support.dms.DmsApplication</mainClass>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

以上为简写。如有疑问，欢迎留言。

在调用的时候，只需要在maven中引入相应的包就可以：例子

<!-- 由于在 support-client\pom.xml 中依赖了 dms-common ,所以不需要重复引入 -->
<dependency>
      <groupId>com.jlc.dmp</groupId>
      <artifactId>support-client</artifactId>
      <version>0.0.1-SNAPSHOT</version>
</dependency>

扫描接口到 spring ioc

@EnableDiscoveryClient
@SpringBootApplication
@EnableFeignClients(basePackages = {
        // dms service
        "com.jlc.dmp.support.dms.client"
})
public class TestApplication {

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

之后自动注入就可以了，不需要再次复制实体对象、写Feign接口

以上内容仅供参考。