SpringCloud微服务工程公共部分提取实战

SpringCloud微服务工程公共部分提取实战

引用

CSDN

1.

https://blog.csdn.net/m0_64284147/article/details/132013292

在SpringCloud微服务工程中，经常会遇到多个模块中存在重复代码的情况，例如重复的实体类。为了减少系统的冗余，提高代码的复用性，我们需要将这些公共部分提取到一个独立的模块中，让其他模块可以共享使用。

1. 创建公共模块

首先，在父工程下新建一个名为api-commons的模块。选择模块的项目类型为Maven，并指定使用的JDK版本。然后填写子模块的名称并完成创建。

2. 配置pom.xml文件

接下来，需要修改api-commons子模块的pom.xml文件，添加必要的依赖。例如，可以添加热部署、Lombok插件和Hutool工具包等依赖。示例如下：

<?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>springcloud01</artifactId>
        <groupId>com.ken.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>api-commons</artifactId>
    <dependencies>
        <!--热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>
        <!--lombok插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!--hutool工具包-->
        <dependency>
            <groupId>cn.hutool</groupId>
            <artifactId>hutool-all</artifactId>
            <version>5.1.0</version>
        </dependency>
    </dependencies>
</project>

3. 新建实体类包

在api-commons模块中新建一个实体类包，例如com.ken.springcloud.entities。然后将所有公共的实体类复制到这个包中。

4. 打包发布到本地Maven仓库

使用Maven命令将api-commons模块打包并发布到本地Maven仓库。首先执行clean命令清理target目录，然后执行install命令进行安装。

5. 删除其他模块中的重复代码

在其他模块中删除已经提取到api-commons中的实体类包。

6. 引入公共模块

在需要使用公共模块的其他模块中，修改pom.xml文件，添加对api-commons的依赖。示例如下：

<dependency>
    <groupId>com.ken.springcloud</groupId>
    <artifactId>api-commons</artifactId>
    <version>${project.version}</version>
</dependency>

7. 测试接口

最后，使用Postman等工具测试接口，确保模块正常运行。例如，可以测试数据插入和查询功能。

通过以上步骤，我们就可以成功地将SpringCloud微服务工程中的公共部分提取到一个独立的模块中，实现代码的复用和系统的优化。