微服务模块搭建与解析

骑猪看日落 2024-03-27 14:37 86阅读 0赞

## 微服务模块搭建与解析 ##

### 1 微服务模块的搭建 ###

一般来说微服务工程主要分为三大类工程：
    - 父工程、基础工程 和微服务工程。

![在这里插入图片描述][6c51e37a7d1c4d5b95f96e7bc7dd8b89.png]

最终项目结构：  
![在这里插入图片描述][f11dfa325c0b4a5f8f819391d3aa0df1.png]  
![在这里插入图片描述][0bbdcf533ddc4edd9681fabee67e6985.png]

> 此处只创建了content一个微服务，其他服务模块类似

#### 1.1 新建一个项目springcloud-plus-pro ####

![在这里插入图片描述][d70c9f64fdd949829467f99b283a0d25.png]

#### 1.2 新建springcloud-plus-parent ####

![在这里插入图片描述][84f0d0a7e95a42d08d06ec32501325da.png]

> 将springcloud-plus-parent设置为pom

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
        <groupId>com.example</groupId>
        <artifactId>springcloud-plus-parent</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springcloud-plus-parent</name>
        <description>springcloud-plus-parent</description>
        
        <packaging>pom</packaging>
    
        
        <properties>
            <java.version>1.8</java.version>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
            <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
            <org.mapstruct.version>1.3.1.Final</org.mapstruct.version>
            <spring-cloud-alibaba.version>2.2.6.RELEASE</spring-cloud-alibaba.version>
            <org.projectlombok.version>1.18.8</org.projectlombok.version>
            <javax.servlet-api.version>4.0.1</javax.servlet-api.version>
            <fastjson.version>1.2.83</fastjson.version>
            <druid-spring-boot-starter.version>1.2.8</druid-spring-boot-starter.version>
            <mysql-connector-java.version>8.0.30</mysql-connector-java.version>
            <mybatis-plus-boot-starter.version>3.4.1</mybatis-plus-boot-starter.version>
            <commons-lang.version>2.6</commons-lang.version>
            <minio.version>8.4.3</minio.version>
            <xxl-job-core.version>2.3.1</xxl-job-core.version>
            <swagger-annotations.version>1.5.20</swagger-annotations.version>
            <commons-lang3.version>3.10</commons-lang3.version>
            <okhttp.version>4.8.1</okhttp.version>
            <swagger-spring-boot-starter.version>1.9.0.RELEASE</swagger-spring-boot-starter.version>
            <elasticsearch.version>7.12.1</elasticsearch.version>
        </properties>
    
    
        <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.boot</groupId>
                    <artifactId>spring-boot-dependencies</artifactId>
                    <version>${
        spring-boot.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                <dependency>
                    <groupId>com.alibaba.cloud</groupId>
                    <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                    <version>${
        spring-cloud-alibaba.version}</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
                
                <dependency>
                    <groupId>org.projectlombok</groupId>
                    <artifactId>lombok</artifactId>
                    <version>${
        org.projectlombok.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>fastjson</artifactId>
                    <version>${
        fastjson.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.alibaba</groupId>
                    <artifactId>druid-spring-boot-starter</artifactId>
                    <version>${
        druid-spring-boot-starter.version}</version>
                </dependency>
    
                
                <dependency>
                    <groupId>mysql</groupId>
                    <artifactId>mysql-connector-java</artifactId>
                    <version>${
        mysql-connector-java.version}</version>
                </dependency>
                
                <dependency>
                    <groupId>com.baomidou</groupId>
                    <artifactId>mybatis-plus-boot-starter</artifactId>
                    <version>${
        mybatis-plus-boot-starter.version}</version>
                </dependency>
                <dependency>
                    <groupId>org.elasticsearch.client</groupId>
                    <artifactId>elasticsearch-rest-high-level-client</artifactId>
                    <version>${
        elasticsearch.version}</version>
                </dependency>
    
                <dependency>
                    <groupId>org.elasticsearch</groupId>
                    <artifactId>elasticsearch</artifactId>
                    <version>${
        elasticsearch.version}</version>
                </dependency>
            </dependencies>
    
        </dependencyManagement>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-compiler-plugin</artifactId>
                    <version>3.8.1</version>
                    <configuration>
                        <source>1.8</source>
                        <target>1.8</target>
                        <encoding>UTF-8</encoding>
                    </configuration>
                </plugin>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.3.7.RELEASE</version>
                    <configuration>
                        <mainClass>com.example.SpringCloudPlusParentApplication</mainClass>
                    </configuration>
                    <executions>
                        <execution>
                            <id>repackage</id>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    
    </project>

项目结构：  
![在这里插入图片描述][222c40369c894c9d921b22da85c2bb2d.png]

#### 1.3 新建springcloud-plus-base ####

> 新建基础工程，父工程为springcloud-plus-parent，目录上平级，因此pom依然需要跳一级（`../`）

![在这里插入图片描述][990b262ee10c41a79c634e802628ab4f.png]  
pom.xml:

> `注意：`base模块下的配置文件可以先删除或者不配置（application.properties）

#### 1.4 新建springcloud-plus-content及其子模块(api、service、model) ####

> 新建微服务模块，以：springcloud-plus-content（内容管理模块）为例

![在这里插入图片描述][d9b7ed61244a40eea016f5d90fecd0e5.png]

> 将项目修改为pom，删除多余部分

新建其子模块：

1. 右击springcloud-plus-content
    2. 选择new - module

分别新建springcloud-plus-content-api、springcloud-plus-content-model、springcloud-plus-content-service模块  
![在这里插入图片描述][290f924814364da38bef0496e2bbdc85.png]

1.  springcloud-plus-content的pom文件

<parent>
            <artifactId>springcloud-plus-parent</artifactId>
            <groupId>com.example</groupId>
            <version>0.0.1-SNAPSHOT</version>
            
            <relativePath>../springcloud-plus-parent</relativePath>
        </parent>
        <artifactId>springcloud-plus-content</artifactId>
        <packaging>pom</packaging>
    
        <modules>
            <module>springcloud-plus-content-api</module>
            <module>springcloud-plus-content-model</module>
            <module>springcloud-plus-content-service</module>
        </modules>

1.  springcloud-plus-content-api模块的pom文件(`model、service同理`)

<parent>
            <artifactId>springcloud-plus-content</artifactId>
            <groupId>com.example</groupId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
        <groupId>com.example</groupId>
        <artifactId>springcloud-plus-content-api</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <name>springcloud-plus-content-api</name>
        <description>springcloud-plus-content-api</description>
    
        <properties>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            
        </dependencies>

最终项目结构：  
![在这里插入图片描述][8cb17c74cc31449fa0dd98728d801052.png]  
![在这里插入图片描述][e9c6e7c121ee463b98b91ce4bdcf5337.png]

### 2 解析微服务模块(搭建流程) ###

1.  创建空项目

> 将所有项目全部放在该文件夹下  
> 例如:`springcloud-plus-pro`

1.  创建parent项目

> 创建总体的父工程，其他不必要文件删除，只留下pom.xml和.iml文件（package为pom），主要管理依赖版本

<properties>
       <java.version>1.8</java.version>
       <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
       <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
       <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
       <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
    </properties>
    
    ...
    <dependencyManagement>
       <dependencies>
       	<dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-dependencies</artifactId>
           <version>${
        spring-cloud.version}</version>
           <type>pom</type>
           <scope>import</scope>    
           ...    
     </dependencies>
    </dependencyManagement>
    
    <build>
    	...
    </build>

> 例如：`springcloud-plus-parent`

1.  创建base项目

> 创建项目总体的base工程，基础工程，pom文件中，依赖spring-plus-parent，文件目录上与springcloud-plus-parent平级【其实也可以将base模块也理解为一个服务】  
> 例如：`springcloud-plus-base`

1.  创建微服务模块

> 创建具体模块，依赖于`springcloud-plus-parent`总体的pom，以内容管理模块为例(content)，文件目录与springcloud-plus-parent平级

*  创建微服务的父工程

> 创建具体服务的父工程，删除不必要文件，留下pom.xml，依赖于springcloud-plus-parent,里面添加模块,管理后面创建的api、service、model  
> 例如：`springcloud-plus-contnet`

*  创建微服务中的子模块之model

> 创建内容管理模块中的model，pom依赖于springcloud-plus-content

*  创建微服务中的子模块之api

> 创建内容管理模块中的api，pom依赖于springcloud-plus-content  
> api的配置文件使用bootstrap.yml,其他model、service使用application.yml，文件优先级。api中的pom依赖content-model和content-service，`这样数据库配置可以只加载一次`

<dependency>
         <groupId>com.zi</groupId>
         <artifactId>zi-plus-content-model</artifactId>
         <version>0.0.1-SNAPSHOT</version>
     </dependency>
     <dependency>
         <groupId>com.zi</groupId>
         <artifactId>zi-plus-content-service</artifactId>
         <version>0.0.1-SNAPSHOT</version>
     </dependency>

*  创建微服务中的子模块之service

> 创建内容管理模块中的service，pom依赖于springcloud-plus-content

1.  添加模块管理

> 在内容管理模块中，添加子模块管理

<modules>
        <module>springcloud-plus-content-api</module>
        <module>springcloud-plus-content-model</module>
        <module>springcloud-plus-content-service</module>
    </modules>

![在这里插入图片描述][584ab74f89a84a37980d2844c89fc5a7.png]

[6c51e37a7d1c4d5b95f96e7bc7dd8b89.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/e12defdc2d474e25b3012470548c197b.png
[f11dfa325c0b4a5f8f819391d3aa0df1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/8cc3a40edc9c496d9d3205036f9ea60a.png
[0bbdcf533ddc4edd9681fabee67e6985.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/da12ef42aa544ad9ad9c4e4881f6f6ac.png
[d70c9f64fdd949829467f99b283a0d25.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/d58a390c896a4e2b8e504ea642f8cb6e.png
[84f0d0a7e95a42d08d06ec32501325da.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/2b62b7ab79a140f6a01956c8820a3e91.png
[222c40369c894c9d921b22da85c2bb2d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/035f823160174502b8ccc25573b716f8.png
[990b262ee10c41a79c634e802628ab4f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/262b8f94b9484badb4aa528cbbfc2397.png
[d9b7ed61244a40eea016f5d90fecd0e5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/01870a14b8f54c71b82337bd2455010f.png
[290f924814364da38bef0496e2bbdc85.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/4951ca85d28d4818a9cea80b4468e08c.png
[8cb17c74cc31449fa0dd98728d801052.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/dff9ba828cdb4b76a09db917326560b0.png
[e9c6e7c121ee463b98b91ce4bdcf5337.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/73a56453f8264a65a81ce1ca805972f6.png
[584ab74f89a84a37980d2844c89fc5a7.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/a42a92faeffd461c88f378b0db88f041.png