微服务基础模块搭建过程

向右看齐 2022-09-14 09:27 219阅读 0赞

一 项目基本模板结构

sdgt_parent：根目录，管理子模块。

  1. common：公共模块父节点
  3.     common-util：工具类模块，所有模块都可以依赖于它
  5.     service-util：service服务的工具包，包含 service服务的公共配置类，所有 service 模块依赖于它
  7. model：实体类模块
  9. service：api 接口服务父节点

二 构建父工程（sdgt_parent）

1 该工程是 Spring Boot 项目

2 它对应的 pom 配置如下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <modules>
  6.         <module>common</module>
  7.         <module>model</module>
  8.         <module>service</module>
  9.     </modules>
  10.     <parent>
  11.         <groupId>org.springframework.boot</groupId>
  12.         <artifactId>spring-boot-starter-parent</artifactId>
  13.         <version>2.2.1.RELEASE</version> <!-- 用该版本 -->
  14.         <relativePath/> 
  15.     </parent>
  17.     <!-- 项目坐标 -->
  18.     <groupId>com.baiyee</groupId>
  19.     <artifactId>sdgt_parent</artifactId>
  20.     <packaging>pom</packaging>
  21.     <version>0.0.1-SNAPSHOT</version>
  22.     <name>sdgt_parent</name>
  23.     <description>Demo project for Spring Boot</description>
  25.     <!-- 版本属性 -->
  26.     <properties>
  27.         <java.version>1.8</java.version>
  28.         <cloud.version>Hoxton.RELEASE</cloud.version>
  29.         <alibaba.version>2.2.0.RELEASE</alibaba.version>
  30.         <mybatis-plus.version>3.3.1</mybatis-plus.version>
  31.         <mysql.version>5.1.46</mysql.version>
  32.         <swagger.version>2.7.0</swagger.version>
  33.         <jwt.version>0.7.0</jwt.version>
  34.         <fastjson.version>1.2.29</fastjson.version>
  35.         <httpclient.version>4.5.1</httpclient.version>
  36.         <easyexcel.version>2.2.0-beta2</easyexcel.version>
  37.         <aliyun.version>4.1.1</aliyun.version>
  38.         <oss.version>3.9.1</oss.version>
  39.         <jodatime.version>2.10.1</jodatime.version>
  40.     </properties>
  43.     <!-- 配置 dependencyManagement 锁定依赖的版本 -->
  44.     <dependencyManagement>
  45.         <dependencies>
  46.             <dependency>
  47.                 <groupId>org.springframework.cloud</groupId>
  48.                 <artifactId>spring-cloud-dependencies</artifactId>
  49.                 <version>${cloud.version}</version>
  50.                 <type>pom</type>
  51.                 <scope>import</scope>
  52.             </dependency>
  54.             <dependency>
  55.                 <groupId>com.alibaba.cloud</groupId>
  56.                 <artifactId>spring-cloud-alibaba-dependencies</artifactId>
  57.                 <version>${alibaba.version}</version>
  58.                 <type>pom</type>
  59.                 <scope>import</scope>
  60.             </dependency>
  62.             <!-- mybatis-plus 持久层-->
  63.             <dependency>
  64.                 <groupId>com.baomidou</groupId>
  65.                 <artifactId>mybatis-plus-boot-starter</artifactId>
  66.                 <version>${mybatis-plus.version}</version>
  67.             </dependency>
  69.             <dependency>
  70.                 <groupId>mysql</groupId>
  71.                 <artifactId>mysql-connector-java</artifactId>
  72.                 <version>${mysql.version}</version>
  73.             </dependency>
  75.             <!-- swagger -->
  76.             <dependency>
  77.                 <groupId>io.springfox</groupId>
  78.                 <artifactId>springfox-swagger2</artifactId>
  79.                 <version>${swagger.version}</version>
  80.             </dependency>
  81.             <!-- swagger ui-->
  82.             <dependency>
  83.                 <groupId>io.springfox</groupId>
  84.                 <artifactId>springfox-swagger-ui</artifactId>
  85.                 <version>${swagger.version}</version>
  86.             </dependency>
  88.             <dependency>
  89.                 <groupId>io.jsonwebtoken</groupId>
  90.                 <artifactId>jjwt</artifactId>
  91.                 <version>${jwt.version}</version>
  92.             </dependency>
  94.             <dependency>
  95.                 <groupId>org.apache.httpcomponents</groupId>
  96.                 <artifactId>httpclient</artifactId>
  97.                 <version>${httpclient.version}</version>
  98.             </dependency>
  100.             <dependency>
  101.                 <groupId>com.alibaba</groupId>
  102.                 <artifactId>fastjson</artifactId>
  103.                 <version>${fastjson.version}</version>
  104.             </dependency>
  106.             <dependency>
  107.                 <groupId>com.alibaba</groupId>
  108.                 <artifactId>easyexcel</artifactId>
  109.                 <version>${easyexcel.version}</version>
  110.             </dependency>
  112.             <dependency>
  113.                 <groupId>com.aliyun</groupId>
  114.                 <artifactId>aliyun-java-sdk-core</artifactId>
  115.                 <version>${aliyun.version}</version>
  116.             </dependency>
  118.             <dependency>
  119.                 <groupId>com.aliyun.oss</groupId>
  120.                 <artifactId>aliyun-sdk-oss</artifactId>
  121.                 <version>${oss.version}</version>
  122.             </dependency>
  124.             <!-- 日期时间工具 -->
  125.             <dependency>
  126.                 <groupId>joda-time</groupId>
  127.                 <artifactId>joda-time</artifactId>
  128.                 <version>${jodatime.version}</version>
  129.             </dependency>
  130.         </dependencies>
  131.     </dependencyManagement>
  134.     <!-- 项目打包时会将 java 录中的 *.xml 文件也进行打包 -->
  135.     <build>
  136.         <resources>
  137.             <resource>
  138.                 <directory>src/main/java</directory>
  139.                 <includes>
  140.                     <include>**/*.xml</include>
  141.                 </includes>
  142.                 <filtering>false</filtering>
  143.             </resource>
  144.         </resources>
  145.     </build>
  146. </project>

三 搭建 common 父模块

1 该项目是 maven 项目

2 pom 文件如下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <!-- 该项目父项目对应坐标 -->
  6.     <parent>
  7.         <artifactId>sdgt_parent</artifactId>
  8.         <groupId>com.baiyee</groupId>
  9.         <version>0.0.1-SNAPSHOT</version>
  10.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  13.     <!-- 该项目坐标 -->
  14.     <artifactId>common</artifactId>
  15.     <packaging>pom</packaging>
  16.     <!-- 该项目的子模块 -->
  17.     <modules>
  18.         <module>common_util</module>
  19.         <module>service_util</module>
  20.     </modules>
  22.     <!-- 该项目依赖 -->
  23.     <dependencies>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-web</artifactId>
  27.             <scope>provided</scope>
  28.         </dependency>
  30.         <!-- mybatis-plus -->
  31.         <dependency>
  32.             <groupId>com.baomidou</groupId>
  33.             <artifactId>mybatis-plus-boot-starter</artifactId>
  34.             <scope>provided</scope>
  35.         </dependency>
  37.         <!-- lombok 用来简化实体类：需要安装 lombok 插件 -->
  38.         <dependency>
  39.             <groupId>org.projectlombok</groupId>
  40.             <artifactId>lombok</artifactId>
  41.         </dependency>
  43.         <!-- swagger -->
  44.         <dependency>
  45.             <groupId>io.springfox</groupId>
  46.             <artifactId>springfox-swagger2</artifactId>
  47.         </dependency>
  48.         <dependency>
  49.             <groupId>io.springfox</groupId>
  50.             <artifactId>springfox-swagger-ui</artifactId>
  51.         </dependency>
  53.         <dependency>
  54.             <groupId>com.alibaba</groupId>
  55.             <artifactId>fastjson</artifactId>
  56.         </dependency>
  57.     </dependencies>
  58. </project>

四 搭建 common-util 模块

1 该项目是 maven 项目

2 对应的 pom 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <!-- 该项目父项目坐标 -->
  6.     <parent>
  7.         <artifactId>common</artifactId>
  8.         <groupId>com.baiyee</groupId>
  9.         <version>0.0.1-SNAPSHOT</version>
  10.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  13.     <!-- 该项目坐标 -->
  14.     <artifactId>common_util</artifactId>
  16.     <!-- 该项目依赖 -->
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>joda-time</groupId>
  20.             <artifactId>joda-time</artifactId>
  21.         </dependency>
  23.         <dependency>
  24.             <groupId>io.jsonwebtoken</groupId>
  25.             <artifactId>jjwt</artifactId>
  26.         </dependency>
  28.         <dependency>
  29.             <groupId>org.apache.httpcomponents</groupId>
  30.             <artifactId>httpclient</artifactId>
  31.         </dependency>
  32.     </dependencies>
  33. </project>

3 一些必要的公共工具类






















SdgtException

自定义全局异常


Result

API统一返回结果封装类


ResultCodeEnum

API统一返回结果状态信息


MD5

MD5加密工具类

五 搭建 service-util 模块

1 该模块是 maven 项目

2 对应的 pom 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <!-- 该项目父项目坐标 -->
  6.     <parent>
  7.         <artifactId>common</artifactId>
  8.         <groupId>com.baiyee</groupId>
  9.         <version>0.0.1-SNAPSHOT</version>
  10.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  13.     <!-- 该项目坐标 -->
  14.     <artifactId>service_util</artifactId>
  16.     <!-- 项目依赖 -->
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>com.baiyee</groupId>
  20.             <artifactId>common_util</artifactId>
  21.             <version>0.0.1-SNAPSHOT</version>
  22.         </dependency>
  24.         <!-- redis -->
  25.         <dependency>
  26.             <groupId>org.springframework.boot</groupId>
  27.             <artifactId>spring-boot-starter-data-redis</artifactId>
  28.         </dependency>
  30.         <!-- spring2.X 集成 redis 所需 common-pool2 -->
  31.         <dependency>
  32.             <groupId>org.apache.commons</groupId>
  33.             <artifactId>commons-pool2</artifactId>
  34.             <version>2.6.0</version>
  35.         </dependency>
  36.     </dependencies>
  37. </project>

六 搭建 model 模块

1 该模块是 maven 项目

2 对应的 pom 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <!-- 该项目父项目坐标 -->
  6.     <parent>
  7.         <artifactId>sdgt_parent</artifactId>
  8.         <groupId>com.baiyee</groupId>
  9.         <version>0.0.1-SNAPSHOT</version>
  10.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  13.     <!-- 该项目坐标 -->
  14.     <artifactId>model</artifactId>
  16.     <!-- 依赖 -->
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>org.projectlombok</groupId>
  20.             <artifactId>lombok</artifactId>
  21.         </dependency>
  22.         <!--mybatis-plus-->
  23.         <dependency>
  24.             <groupId>com.baomidou</groupId>
  25.             <artifactId>mybatis-plus-boot-starter</artifactId>
  26.             <scope>provided</scope>
  27.         </dependency>
  28.         <!--swagger-->
  29.         <dependency>
  30.             <groupId>io.springfox</groupId>
  31.             <artifactId>springfox-swagger2</artifactId>
  32.             <scope>provided</scope>
  33.         </dependency>
  34.         <dependency>
  35.             <groupId>com.alibaba</groupId>
  36.             <artifactId>easyexcel</artifactId>
  37.             <scope>provided</scope>
  38.         </dependency>
  39.         <dependency>
  40.             <groupId>com.alibaba</groupId>
  41.             <artifactId>fastjson</artifactId>
  42.             <scope>provided</scope>
  43.         </dependency>
  44.     </dependencies>
  45. </project>

七 搭建service父模块

1 该模块是 maven 项目

2 对应的 pom 文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>sdgt_parent</artifactId>
  7.         <groupId>com.baiyee</groupId>
  8.         <version>0.0.1-SNAPSHOT</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>service</artifactId>
  13.     <packaging>pom</packaging>
  14.     <modules>
  15.         <module>service_hosp</module>
  16.     </modules>
  17.     <dependencies>
  18.         <dependency>
  19.             <groupId>com.baiyee</groupId>
  20.             <artifactId>model</artifactId>
  21.             <version>0.0.1-SNAPSHOT</version>
  22.         </dependency>
  23.         <dependency>
  24.             <groupId>com.baiyee</groupId>
  25.             <artifactId>service_util</artifactId>
  26.             <version>0.0.1-SNAPSHOT</version>
  27.         </dependency>
  28.         <!-- web -->
  29.         <dependency>
  30.             <groupId>org.springframework.boot</groupId>
  31.             <artifactId>spring-boot-starter-web</artifactId>
  32.         </dependency>
  33.         <!-- mybatis-plus -->
  34.         <dependency>
  35.             <groupId>com.baomidou</groupId>
  36.             <artifactId>mybatis-plus-boot-starter</artifactId>
  37.         </dependency>
  38.         <!-- mysql -->
  39.         <dependency>
  40.             <groupId>mysql</groupId>
  41.             <artifactId>mysql-connector-java</artifactId>
  42.         </dependency>
  43.         <!-- 开发者工具 -->
  44.         <dependency>
  45.             <groupId>org.springframework.boot</groupId>
  46.             <artifactId>spring-boot-devtools</artifactId>
  47.             <optional>true</optional>
  48.         </dependency>
  49.     </dependencies>
  50.     <build>
  51.         <plugins>
  52.             <plugin>
  53.                 <groupId>org.springframework.boot</groupId>
  54.                 <artifactId>spring-boot-maven-plugin</artifactId>
  55.             </plugin>
  56.         </plugins>
  57.         <resources>
  58.             <resource>
  59.                 <directory>src/main/java</directory>
  60.                 <includes>
  61.                     <include>**/*.yml</include>
  62.                     <include>**/*.properties</include>
  63.                     <include>**/*.xml</include>
  64.                 </includes>
  65.                 <filtering>false</filtering>
  66.             </resource>
  67.             <resource>
  68.                 <directory>src/main/resources</directory>
  69.                 <includes>
  70.                     <include>**/*.yml</include>
  71.                     <include>**/*.properties</include>
  72.                     <include>**/*.xml</include>
  73.                 </includes>
  74.                 <filtering>false</filtering>
  75.             </resource>
  76.         </resources>
  77.     </build>
  78. </project>

发表评论

表情：
评论列表 （有 0 条评论，219人围观）

还没有评论，来说两句吧...

相关阅读