IntelliJ IDEA 2018.3 创建 Maven 多模块(Module)项目+负载均衡【持续更新】

2019年08月05日 17:58 · 阅读(7337) ·

参考

Java 项目学习笔记

IntelliJ IDEA创建maven多模块项目

IntelliJ IDEA知识集锦

springcloud(二)：注册中心Eureka

springcloud(三)：服务提供与调用

10.Spring Cloud-服务注册与发现(Eureka)

pom.xml 中定义和使用变量

开发环境

名称 版本
操作系统 Windows 10 X64
JDK JDK1.8（jdk-8u151-windows-x64）
IntelliJ IDEA IntelliJ IDEA 2018.3
Maven Maven 3.6.0

测试表-t_rbt_test

位于本地 MySql 数据库 luoma_test 下

  1. SET NAMES utf8mb4;
  2. SET FOREIGN_KEY_CHECKS = 0;
  4. -- ----------------------------
  5. -- Table structure for t_rbt_test
  6. -- ----------------------------
  7. DROP TABLE IF EXISTS `t_rbt_test`;
  8. CREATE TABLE `t_rbt_test`  (
  9.   `id` varchar(100) CHARACTER SET utf8 COLLATE utf8_unicode_ci NOT NULL COMMENT '主键',
  10.   `name` varchar(50) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '名称',
  11.   `version` varchar(20) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '版本号',
  12.   `create_by` varchar(50) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '创建人',
  13.   `create_time` timestamp(0) NULL DEFAULT NULL COMMENT '创建时间',
  14.   `update_by` varchar(50) CHARACTER SET utf8 COLLATE utf8_unicode_ci NULL DEFAULT NULL COMMENT '修改人',
  15.   `update_time` timestamp(0) NULL DEFAULT NULL COMMENT '修改时间',
  16.   `is_delete` int(1) NULL DEFAULT NULL COMMENT '是否删除',
  17.   `biz_time` timestamp(0) NULL DEFAULT NULL COMMENT '系统时间戳',
  18.   PRIMARY KEY (`id`) USING BTREE
  19. ) ENGINE = InnoDB CHARACTER SET = utf8 COLLATE = utf8_unicode_ci ROW_FORMAT = Dynamic;
  21. SET FOREIGN_KEY_CHECKS = 1;

组件引用说明

由于篇幅有限，加上侧重点的问题。本文中引用的组件请参考

常用 Maven 组件 pom 配置，import 及使用

项目源代码

见附件

创建父模块-test-invoice-cloud

文件-New-项目

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

依次补全下面的信息，点击 下一个

节点 描述
groupId 代表组织和整个项目的唯一标志，是项目组织唯一的知标识符，实际对应 JAVA 的包的结构
artifactId 项目的唯一的标识符，实际对应项目的名称
version 用于说明目前项目的版本

输入项目名称 test-invoice-cloud ，我们主要是在这个项目下创建我们的子模块

这样我们就创建好了一个普通项目，因为该项目是作为一个解决方案存在的，可以直接删除 src 文件夹

创建好的项目如下

项目文件名称及含义

目录/文件 含义
.idea 创建项目的时候自动创建一个 .idea 的项目配置目录来保存项目的配置信息。这是默认选项。 子目录包含一系列XML文件，包括：compiler.xml、encodings.xml、modules.xml等。这些文件记录工程本身的核心信息，包括：模块组件的名称和位置、编译器设置等，可以存放到VCS。一个例外是workspace.xml，该文件存储个人设置（例如窗口位置）以及其它附属于开发环境的信息，不应该存放到VCS
pom.xml Maven 项目配置文件。POM( Project Object Model，项目对象模型 ) 是 Maven 工程的基本工作单元，是一个XML文件，包含了项目的基本信息，用于描述项目如何构建，声明项目依赖，等等。执行任务或目标时，Maven 会在当前目录中查找 POM。它读取 POM，获取所需的配置信息，然后执行目标。
.iml 模块是工程中一个可以独立编译、运行、调试、测试的单元。模块的配置信息默认存放在其内容根目录（Content root folder）下的 .iml 文件中，该文件一般存放到VCS。

设置 Maven 引用地址

注意，这里的设置是必须的。相关组件的下载就需要这里的配置。

设置 Maven 引用地址

pom.xml

  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">
  6.     <!--父级：Spring Boot-->
  7.     <parent>
  8.         <groupId>org.springframework.boot</groupId>
  9.         <artifactId>spring-boot-starter-parent</artifactId>
  10.         <!--<version>2.0.1.RELEASE</version>-->
  11.         <!--<version>2.0.3.RELEASE</version>--><!--解决循环引用对象问题mybatis https://github.com/heikehuan/springboot-multiple-dataSources/issues/2-->
  12.         <version>2.0.9.RELEASE</version>
  13.     </parent>
  16.     <modelVersion>4.0.0</modelVersion>
  17.     <groupId>com-test-invoice</groupId>
  18.     <artifactId>test-invoice-cloud</artifactId>
  19.     <version>1.0-SNAPSHOT</version>
  21.     <name>test-invoice-cloud</name>
  22.     <packaging>pom</packaging>
  25.     <modules>
  26.         <module>test-invoice-common</module>
  27.         <module>test-invoice-contract</module>
  28.         <module>test-invoice-service</module>
  29.         <module>test-invoice-web</module>
  30.         <module>test-invoice-eureka</module>
  31.     </modules>
  33.     <properties>
  34.         <springCloud.version>Finchley.RELEASE</springCloud.version>
  35.         <fastjson.version>1.2.38</fastjson.version>
  36.         <swagger.version>2.7.0</swagger.version>
  37.         <lombok.version>1.18.6</lombok.version>
  39.         <HikariCP.version>3.3.1</HikariCP.version>
  40.         <mybatis-plus-spring-boot-starter.version>3.1.0</mybatis-plus-spring-boot-starter.version>
  41.         <swagger-ui.version>2.7.0</swagger-ui.version>
  42.     </properties>
  44.     <!--Spring Cloud 版本序列配置-->
  45.     <dependencyManagement>
  46.         <dependencies>
  47.             <dependency>
  48.                 <groupId>org.springframework.cloud</groupId>
  49.                 <artifactId>spring-cloud-dependencies</artifactId>
  50.                 <version>${springCloud.version}</version>
  51.                 <type>pom</type>
  52.                 <scope>import</scope>
  53.                 <exclusions>
  54.                     <exclusion>
  55.                         <groupId>redis.clients</groupId>
  56.                         <artifactId>jedis</artifactId>
  57.                     </exclusion>
  58.                 </exclusions>
  59.             </dependency>
  60.         </dependencies>
  61.     </dependencyManagement>
  64.     <dependencies>
  65.         <!--Spring Boot 执行器组件-->
  66.         <dependency>
  67.             <groupId>org.springframework.boot</groupId>
  68.             <artifactId>spring-boot-starter-actuator</artifactId>
  69.         </dependency>
  70.         <!--Spring Cloud 基础-->
  71.         <dependency>
  72.             <groupId>org.springframework.cloud</groupId>
  73.             <artifactId>spring-cloud-starter</artifactId>
  74.         </dependency>
  75.         <!--Spring Cloud 服务注册组件-->
  76.         <dependency>
  77.             <groupId>org.springframework.cloud</groupId>
  78.             <!--此处的依赖是SpringBoot2.0以后专用的，如果您使用的SpringBoot版本低于2.0请使用spring-cloud-starter-eureka-server-->
  79.             <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
  80.         </dependency>
  82.         <!--Spring Boot 测试组件-->
  83.         <dependency>
  84.             <groupId>org.springframework.boot</groupId>
  85.             <artifactId>spring-boot-starter-test</artifactId>
  86.             <scope>test</scope>
  87.         </dependency>
  90.         <!--Spring Boot Web组件-->
  91.         <dependency>
  92.             <groupId>org.springframework.boot</groupId>
  93.             <artifactId>spring-boot-starter-web</artifactId>
  94.             <!-- 从依赖信息里移除 Tomcat配置 -->
  95.             <exclusions>
  96.                 <exclusion>
  97.                     <groupId>org.springframework.boot</groupId>
  98.                     <artifactId>spring-boot-starter-tomcat</artifactId>
  99.                 </exclusion>
  100.             </exclusions>
  101.         </dependency>
  103.         <!-- 参数校验信息 -->
  104.         <dependency>
  105.             <groupId>org.springframework.boot</groupId>
  106.             <artifactId>spring-boot-starter-validation</artifactId>
  107.         </dependency>
  109.         <!-- 添加 Undertow依赖 start-->
  110.         <dependency>
  111.             <groupId>org.springframework.boot</groupId>
  112.             <artifactId>spring-boot-starter-undertow</artifactId>
  113.         </dependency>
  114.         <!-- 添加 Undertow依赖 end-->
  116.         <!-- spring aop start -->
  117.         <dependency>
  118.             <groupId>org.springframework.boot</groupId>
  119.             <artifactId>spring-boot-starter-aop</artifactId>
  120.         </dependency>
  121.         <!-- spring aop end -->
  123.         <!--lombok start-->
  124.         <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
  125.         <dependency>
  126.             <groupId>org.projectlombok</groupId>
  127.             <artifactId>lombok</artifactId>
  128.             <version>${lombok.version}</version>
  129.         </dependency>
  130.         <!--lombok end-->
  132.         <!--fastJson start-->
  133.         <!--Fastjson是一个Java语言编写的高性能功能完善的JSON库。它采用一种“假定有序快速匹配”的算法，把JSON Parse的性能提升到极致，是目前Java语言中最快的JSON库-->
  134.         <dependency>
  135.             <groupId>com.alibaba</groupId>
  136.             <artifactId>fastjson</artifactId>
  137.             <version>${fastjson.version}</version>
  138.         </dependency>
  139.         <!--fastJson end-->
  141.         <!--swagger start-->
  142.         <!--springfox是通过注解的形式自动生成API文档，利用它，可以很方便的书写restful API，swagger主要用于展示springfox生成的API文档-->
  143.         <dependency>
  144.             <groupId>io.springfox</groupId>
  145.             <artifactId>springfox-swagger2</artifactId>
  146.             <version>${swagger.version}</version>
  147.         </dependency>
  148.         <!--swagger end-->
  151.     </dependencies>
  153.     <!--注意：这里必须要添加，否则各种依赖有问题-->
  154.     <repositories>
  155.         <repository>
  156.             <id>spring-milestones</id>
  157.             <name>Spring Milestones</name>
  158.             <url>https://repo.spring.io/libs-milestone</url>
  159.             <snapshots>
  160.                 <enabled>false</enabled>
  161.             </snapshots>
  162.         </repository>
  163.     </repositories>
  165.     <build>
  166.         <plugins>
  167.             <plugin>
  168.                 <!-- 指定maven编译的jdk版本,如果不指定,maven3默认用jdk 1.5 maven2默认用jdk1.3 -->
  169.                 <groupId>org.apache.maven.plugins</groupId>
  170.                 <artifactId>maven-compiler-plugin</artifactId>
  171.                 <version>3.1</version>
  172.                 <configuration>
  173.                     <!-- 一般而言，target与source是保持一致的，但是，有时候为了让程序能在其他版本的jdk中运行(对于低版本目标jdk，源代码中不能使用低版本jdk中不支持的语法)，会存在target不同于source的情况 -->
  174.                     <source>1.8</source> <!-- 源代码使用的JDK版本 -->
  175.                     <target>1.8</target> <!-- 需要生成的目标class文件的编译版本 -->
  176.                     <encoding>UTF-8</encoding><!-- 字符集编码 -->
  177.                     <!--<skipTests>true</skipTests>&lt;!&ndash; 跳过测试 &ndash;&gt;
  178.                     <verbose>true</verbose>
  179.                     <showWarnings>true</showWarnings>
  180.                     <fork>true</fork>&lt;!&ndash; 要使compilerVersion标签生效，还需要将fork设为true，用于明确表示编译版本配置的可用 &ndash;&gt;
  181.                     <executable>&lt;!&ndash; path-to-javac &ndash;&gt;</executable>&lt;!&ndash; 使用指定的javac命令，例如：<executable>${JAVA_1_4_HOME}/bin/javac</executable> &ndash;&gt;
  182.                     <compilerVersion>1.3</compilerVersion>&lt;!&ndash; 指定插件将使用的编译器的版本 &ndash;&gt;
  183.                     <meminitial>128m</meminitial>&lt;!&ndash; 编译器使用的初始内存 &ndash;&gt;
  184.                     <maxmem>512m</maxmem>&lt;!&ndash; 编译器使用的最大内存 &ndash;&gt;
  185.                     <compilerArgument>-verbose -bootclasspath ${java.home}\lib\rt.jar</compilerArgument>--><!-- 这个选项用来传递编译器自身不包含但是却支持的参数选项 -->
  186.                 </configuration>
  187.             </plugin>
  188.             <plugin>
  189.                 <groupId>org.sonarsource.scanner.maven</groupId>
  190.                 <artifactId>sonar-maven-plugin</artifactId>
  191.                 <version>3.5.0.1254</version>
  192.             </plugin>
  193.         </plugins>
  194.     </build>
  195. </project>

创建子模块-test-invoice-eureka

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-eureka

模块名称 test-invoice-eureka

创建类和文件

模块简介

这个模块对应的是 Eureka Server

Eureka Server 提供服务注册服务，各个节点启动后，会在 Eureka Server 中进行注册，这样 EurekaServer 中的服务注册表中将会存储所有可用服务节点的信息，服务节点的信息可以在界面中直观的看到。

这里只是作为项目中的一个模块，详细的了解可参考下面的内容

springcloud(二)：注册中心Eureka

springcloud(三)：服务提供与调用

10.Spring Cloud-服务注册与发现(Eureka)

pom.xml

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-eureka</artifactId>
  13.     <name>test-invoice-eureka</name>
  15.     <properties>
  16.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  17.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.cloud</groupId>
  22.             <artifactId>spring-cloud-netflix-eureka-server</artifactId>
  23.             <version>2.0.0.M7</version>
  24.             <scope>compile</scope>
  25.         </dependency>
  26.         <dependency>
  27.             <groupId>junit</groupId>
  28.             <artifactId>junit</artifactId>
  29.             <scope>test</scope>
  30.         </dependency>
  31.     </dependencies>
  33.     <build>
  34.         <finalName>${project.artifactId}</finalName>
  35.         <plugins>
  36.             <plugin>
  37.                 <groupId>org.springframework.boot</groupId>
  38.                 <artifactId>spring-boot-maven-plugin</artifactId>
  39.             </plugin>
  40.         </plugins>
  41.         <resources>
  42.             <resource>
  43.                 <directory>src/main/resources</directory>
  44.                 <includes>
  45.                     <include>**/*</include>
  46.                 </includes>
  47.             </resource>
  48.         </resources>
  49.     </build>
  50. </project>

yml

application.yml

  1. spring:
  2.   # 节点1的标签
  3.   profiles:
  4.     active: dev
  5.   activiti:
  6.     check-process-definitions: false #校验流程文件，默认校验resources下的processes文件夹里的流程文件
  7.   # 服务名保持一致
  8.   application:
  9.     name: eureka-ha

application-dev.yml

  1. server:
  2.   port: 8772
  4. # 配置Eureka Server 信息
  5. eureka:
  6.   client:
  7.     # 表示是否将自己注册到Eureka Server，不进行注册（当服务注册中心是单点而非高可用时的配置方式）
  8.     registerWithEureka: false
  9.     # 表示是否从Eureka Server获取注册信息，不获取注册信息（当服务注册中心是单点而非高可用时的配置方式）
  10.     fetchRegistry: false
  11.     #设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址。默认是http://localhost:8761/eureka ；多个地址可使用 , 分隔
  12.     service-url:
  13.       defaultZone: http://localhost:${server.port}/eureka/
  14.   # 自定义实例编号
  15.   instance:
  16.     instance-id: ${spring.application.name}:${server.port}
  17.     # 配置使用主机名注册服务
  18.     #hostname: peer1
  19.     # 优先使用IP地址方式进行注册服务
  20.     prefer-ip-address: true
  21.     # 配置使用指定IP
  22.     ip-address: 127.0.0.1

入口类-EurekaHaApplication

  1. package com.test.eurekaha;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration;
  6. import org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration;
  7. import org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration;
  8. import org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration;
  9. import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
  11. /**
  12.  * EurekaHaApplication
  13.  *
  14.  * @author:
  15.  * @version:
  16.  * @date: 2019-08-13 15:26
  17.  */
  19. //排除掉数据库配置项目
  20. @SpringBootApplication(      exclude = {
  21.         DataSourceAutoConfiguration.class,
  22.         DataSourceTransactionManagerAutoConfiguration.class,
  23.         RedisAutoConfiguration.class,
  24.         RedisRepositoriesAutoConfiguration.class
  25. })
  26. @EnableEurekaServer
  27. public class EurekaHaApplication {
  28.     public static void main(String[] args) {
  29.         SpringApplication.run(EurekaHaApplication.class, args);
  30.     }
  31. }

测试

创建成功后，启动项目，访问 http://localhost:8772/

创建子模块-test-invoice-common

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-common

模块名称 test-invoice-common

模块简介

test-invoice-common 这个模块主要是创建一些公共类，实体提供给其它模块使用

新建测试类-TRbtTestData

新建包 com.test.invoice

再新建类 TRbtTestData

属性私有，行为公有

所以这里我们把属性设置为 private，通过 get 和 set 来获取设置值

  1. package com.test.invoice.data;
  3. import com.alibaba.fastjson.annotation.JSONField;
  4. import io.swagger.annotations.ApiModelProperty;
  5. import lombok.Data;
  6. import lombok.experimental.Accessors;
  8. @Data
  9. @Accessors(chain = true)
  10. public class TRbtTestData {
  12.     @ApiModelProperty("名称")
  13.     @JSONField(name = "name")
  14.     private String name;
  16.     @ApiModelProperty("版本号")
  17.     @JSONField(name = "version")
  18.     private String version;
  19. }

这个类引入了很多包，需要在 pom.xml 引入

父模块 pom.xml 引入包子模块 pom.xml 无法解析问题

问题描述

TRbtTestData 类需要引入一些包，我们再最外层 test-invoice-cloud 的 pom.xml 中引入包

这个 pom.xml 中使用到了自定义变量，可以参考

pom.xml 中定义和使用变量

  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">
  6.     <!--父级：Spring Boot-->
  7.     <parent>
  8.         <groupId>org.springframework.boot</groupId>
  9.         <artifactId>spring-boot-starter-parent</artifactId>
  10.         <!--<version>2.0.1.RELEASE</version>-->
  11.         <!--<version>2.0.3.RELEASE</version>--><!--解决循环引用对象问题mybatis https://github.com/heikehuan/springboot-multiple-dataSources/issues/2-->
  12.         <version>2.0.9.RELEASE</version>
  13.     </parent>
  16.     <modelVersion>4.0.0</modelVersion>
  18.     <groupId>com-test-invoice</groupId>
  19.     <artifactId>test-invoice-cloud</artifactId>
  20.     <packaging>pom</packaging>
  21.     <version>1.0-SNAPSHOT</version>
  22.     <name>test-invoice-cloud</name>
  25.     <modules>
  26.         <module>test-invoice-common</module>
  27.     </modules>
  29.     <properties>
  30.         <fastjson.version>1.2.38</fastjson.version>
  31.         <swagger.version>2.7.0</swagger.version>
  32.         <lombok.version>1.18.6</lombok.version>
  33.     </properties>
  36.     <dependencies>
  37.         <!--Spring Boot 执行器组件-->
  38.         <dependency>
  39.             <groupId>org.springframework.boot</groupId>
  40.             <artifactId>spring-boot-starter-actuator</artifactId>
  41.         </dependency>
  42.         <!--Spring Cloud 基础-->
  43.         <dependency>
  44.             <groupId>org.springframework.cloud</groupId>
  45.             <artifactId>spring-cloud-starter</artifactId>
  46.         </dependency>
  47.         <!--Spring Cloud 服务注册组件-->
  48.         <dependency>
  49.             <groupId>org.springframework.cloud</groupId>
  50.             <!--此处的依赖是SpringBoot2.0以后专用的，如果您使用的SpringBoot版本低于2.0请使用spring-cloud-starter-eureka-server-->
  51.             <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
  52.         </dependency>
  54.         <!--Spring Boot 测试组件-->
  55.         <dependency>
  56.             <groupId>org.springframework.boot</groupId>
  57.             <artifactId>spring-boot-starter-test</artifactId>
  58.             <scope>test</scope>
  59.         </dependency>
  62.         <!--Spring Boot Web组件-->
  63.         <dependency>
  64.             <groupId>org.springframework.boot</groupId>
  65.             <artifactId>spring-boot-starter-web</artifactId>
  66.             <!-- 从依赖信息里移除 Tomcat配置 -->
  67.             <exclusions>
  68.                 <exclusion>
  69.                     <groupId>org.springframework.boot</groupId>
  70.                     <artifactId>spring-boot-starter-tomcat</artifactId>
  71.                 </exclusion>
  72.             </exclusions>
  73.         </dependency>
  75.         <!-- spring aop start -->
  76.         <dependency>
  77.             <groupId>org.springframework.boot</groupId>
  78.             <artifactId>spring-boot-starter-aop</artifactId>
  79.         </dependency>
  80.         <!-- spring aop end -->
  82.         <!--fastJson start-->
  83.         <!--Fastjson是一个Java语言编写的高性能功能完善的JSON库。它采用一种“假定有序快速匹配”的算法，把JSON Parse的性能提升到极致，是目前Java语言中最快的JSON库-->
  84.         <dependency>
  85.             <groupId>com.alibaba</groupId>
  86.             <artifactId>fastjson</artifactId>
  87.             <version>${fastjson.version}</version>
  88.         </dependency>
  89.         <!--fastJson end-->
  91.         <!--swagger start-->
  92.         <!--springfox是通过注解的形式自动生成API文档，利用它，可以很方便的书写restful API，swagger主要用于展示springfox生成的API文档-->
  93.         <dependency>
  94.             <groupId>io.springfox</groupId>
  95.             <artifactId>springfox-swagger2</artifactId>
  96.             <version>${swagger.version}</version>
  97.         </dependency>
  98.         <!--swagger end-->
  100.         <!--lombok start-->
  101.         <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
  102.         <dependency>
  103.             <groupId>org.projectlombok</groupId>
  104.             <artifactId>lombok</artifactId>
  105.             <version>${lombok.version}</version>
  106.         </dependency>
  107.         <!--lombok end-->
  108.     </dependencies>
  111. </project>

test-invoice-common 的 pom.xml 中不引入，因为是父子模块，子模块就不用再引用了

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-common</artifactId>
  13.     <name>test-invoice-common</name>
  14. </project>

构建，报下面的错误

  1. 程序包 xx 不存在

问题解决

原因是子模块没有引入对应包内容

打开右边的 Maven 选项卡，发现 test-invoice-common 没有 Dependencies 内容

在 test-invoice-common 的 pom.xml 中加入下面的内容

  1. <properties>
  2.     <mybatisplus.version>3.1.0</mybatisplus.version>
  3. </properties>
  5. <dependencies>
  6.     <!--MyBatis-Plus-->
  7.     <dependency>
  8.         <groupId>com.baomidou</groupId>
  9.         <artifactId>mybatis-plus</artifactId>
  10.         <version>${mybatisplus.version}</version>
  11.     </dependency>
  12. </dependencies>

完整 pom.xml

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-common</artifactId>
  13.     <name>test-invoice-common</name>
  15.     <properties>
  16.         <mybatisplus.version>3.1.0</mybatisplus.version>
  17.     </properties>
  19.     <dependencies>
  20.         <!--MyBatis-Plus-->
  21.         <dependency>
  22.             <groupId>com.baomidou</groupId>
  23.             <artifactId>mybatis-plus</artifactId>
  24.             <version>${mybatisplus.version}</version>
  25.         </dependency>
  26.     </dependencies>
  27. </project>

重新导入

导入成功后重新构建项目，成功

打开右边的 Maven 选项卡，Dependencies 内容出现

问题原因

去掉 在 test-invoice-common 的 pom.xml 中的内容

  1. <properties>
  2.     <mybatisplus.version>3.1.0</mybatisplus.version>
  3. </properties>
  5. <dependencies>
  6.     <!--MyBatis-Plus-->
  7.     <dependency>
  8.         <groupId>com.baomidou</groupId>
  9.         <artifactId>mybatis-plus</artifactId>
  10.         <version>${mybatisplus.version}</version>
  11.     </dependency>
  12. </dependencies>

重新构建项目，也成功。

说明这个问题的原因是 IDE 不够智能引起的，有时候会加载不到对应的包引用，需要再重新构建才可以。

创建下图中的类和文件

类图

pom.xml

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-common</artifactId>
  13.     <name>test-invoice-common</name>
  15.     <properties>
  16.         <mybatisplus.version>3.1.0</mybatisplus.version>
  17.     </properties>
  19.     <dependencies>
  20.         <!--MyBatis-Plus （简称 MP）是一个 MyBatis 的增强工具，在 MyBatis 的基础上只做增强不做改变-->
  21.         <dependency>
  22.             <groupId>com.baomidou</groupId>
  23.             <artifactId>mybatis-plus</artifactId>
  24.             <version>${mybatisplus.version}</version>
  25.         </dependency>
  26.         <!--Dozer是一个JavaBean映射工具库。它支持简单的属性映射，复杂类型映射，双向映射，隐式显式的映射，以及递归映射-->
  27.         <dependency>
  28.             <groupId>com.github.dozermapper</groupId>
  29.             <artifactId>dozer-core</artifactId>
  30.             <version>6.1.0</version>
  31.         </dependency>
  32.         <!--JUnit 是一个Java编程语言的单元测试框架-->
  33.         <dependency>
  34.             <groupId>junit</groupId>
  35.             <artifactId>junit</artifactId>
  36.             <scope>test</scope>
  37.         </dependency>
  38.         <!--bouncy castle（轻量级密码术包）是一种用于 Java 平台的开放源码的轻量级密码术包；它支持大量的密码术算法，并提供JCE 1.2.1的实现-->
  39.         <dependency>
  40.             <groupId>org.bouncycastle</groupId>
  41.             <artifactId>bcprov-jdk15on</artifactId>
  42.             <version>1.55</version>
  43.         </dependency>
  44.         <!--密码加密框架-->
  45.         <dependency>
  46.             <groupId>com.madgag.spongycastle</groupId>
  47.             <artifactId>core</artifactId>
  48.             <version>1.54.0.0</version>
  49.         </dependency>
  50.     </dependencies>
  51. </project>

基础实体类-SuperEntity

  1. package com.test.invoice.model.base;
  3. import com.baomidou.mybatisplus.annotation.FieldFill;
  4. import com.baomidou.mybatisplus.annotation.IdType;
  5. import com.baomidou.mybatisplus.annotation.TableField;
  6. import com.baomidou.mybatisplus.annotation.TableId;
  7. import com.baomidou.mybatisplus.extension.activerecord.Model;
  8. import com.fasterxml.jackson.annotation.JsonFormat;
  9. import io.swagger.annotations.ApiModel;
  10. import io.swagger.annotations.ApiModelProperty;
  11. import lombok.Data;
  12. import lombok.EqualsAndHashCode;
  13. import lombok.experimental.Accessors;
  15. import java.io.Serializable;
  16. import java.util.Date;
  18. /**
  19.  * 基础实体类
  20.  *
  21.  * @author:
  22.  * @version:
  23.  * @date: 2019-08-09 14:26
  24.  */
  25. @EqualsAndHashCode(callSuper = true)
  26. @Data
  27. @Accessors(chain = true)
  28. public class SuperEntity<T extends Model> extends Model<T> {
  29.     @TableId(type = IdType.UUID)
  30.     @ApiModelProperty(value = "主键")
  31.     private String id;
  33.     @ApiModelProperty(value="创建时间",hidden = true)
  34.     @TableField(value="create_time",fill = FieldFill.INSERT)
  35.     @JsonFormat(timezone = "GMT+8",pattern = "yyyy-MM-dd HH:mm:ss")
  36.     private Date createTime;
  38.     @TableField(value = "update_time", fill = FieldFill.INSERT_UPDATE)
  39.     @ApiModelProperty(value = "修改时间", hidden = true)
  40.     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
  41.     private Date updateTime;
  43.     @ApiModelProperty(value = "创建人", hidden = true)
  44.     @TableField(value = "create_by", fill = FieldFill.INSERT)
  45.     private String createBy;
  47.     @ApiModelProperty(value = "修改人", hidden = true)
  48.     @TableField(value = "update_by", fill = FieldFill.INSERT_UPDATE)
  49.     private String updateBy;
  51.     @ApiModelProperty(value = "是否删除（0：未删除；1：已删除）", hidden = true)
  52.     @TableField(value = "is_delete", fill = FieldFill.INSERT)
  53.     private Integer isDelete;
  55.     @ApiModelProperty(value = "系统时间戳", hidden = true)
  56.     @TableField(value = "biz_time", fill = FieldFill.INSERT_UPDATE)
  57.     @JsonFormat(timezone = "GMT+8", pattern = "yyyy-MM-dd HH:mm:ss")
  58.     private Date bizTime;
  60.     @Override
  61.     protected Serializable pkVal() { return this.id; }
  62. }

t_rbt_test 表对应实体类-TRbtTestEntity

  1. package com.test.invoice.model;
  3. import com.baomidou.mybatisplus.annotation.TableName;
  4. import com.test.invoice.model.base.SuperEntity;
  5. import io.swagger.annotations.ApiModelProperty;
  6. import lombok.Data;
  7. import lombok.EqualsAndHashCode;
  8. import lombok.ToString;
  9. import lombok.experimental.Accessors;
  11. /**
  12.  * t_rbt_test 表对应实体类-TRbtTestEntity
  13.  *
  14.  * @author:
  15.  * @version:
  16.  * @date: 2019-08-09 14:25
  17.  */
  18. @Data
  19. @EqualsAndHashCode(callSuper = true)
  20. @Accessors(chain = true)
  21. @ToString
  22. @TableName("t_rbt_test")
  23. public class TRbtTestEntity extends SuperEntity {
  25.     @ApiModelProperty("名称")
  26.     private String name;
  28.     @ApiModelProperty("版本号")
  29.     private String version;
  31. }

TRbtTestData 参数类

  1. package com.test.invoice.data;
  3. import com.alibaba.fastjson.annotation.JSONField;
  4. import io.swagger.annotations.ApiModelProperty;
  5. import lombok.Data;
  6. import lombok.experimental.Accessors;
  8. /**
  9.  * TRbtTestData 参数类
  10.  *
  11.  * @author:
  12.  * @version:
  13.  * @date: 2019-08-09 08:57
  14.  */
  15. @Data
  16. @Accessors(chain = true) //@Accessors 注解用来配置lombok如何产生和显示getters和setters的方法。
  17. public class TRbtTestData {
  18.     @ApiModelProperty("id")
  19.     @JSONField(name = "id")
  20.     private String id;
  22.     @ApiModelProperty("名称")
  23.     @JSONField(name = "name")
  24.     private String name;
  26.     @ApiModelProperty("版本号")
  27.     @JSONField(name = "version")
  28.     private String version;
  29. }

TRbtTestData 分页对象类

  1. package com.test.invoice.data;
  3. import com.alibaba.fastjson.annotation.JSONField;
  4. import com.test.invoice.model.base.SuperEntity;
  5. import io.swagger.annotations.ApiModelProperty;
  6. import lombok.Data;
  7. import lombok.experimental.Accessors;
  9. /**
  10.  * TRbtTestData 分页对象类
  11.  *
  12.  * @author:
  13.  * @version:
  14.  * @date: 2019-08-15 16:49
  15.  */
  16. @Data
  17. @Accessors(chain = true) //@Accessors 注解用来配置lombok如何产生和显示getters和setters的方法。
  18. public class TRbtTestDataParam extends SuperEntity {
  19.     @ApiModelProperty("当前页")
  20.     @JSONField(name = "page")
  21.     private Integer page;
  23.     @ApiModelProperty("页面大小")
  24.     @JSONField(name = "pageSize")
  25.     private Integer pageSize;
  27.     @ApiModelProperty("名称")
  28.     @JSONField(name = "name")
  29.     private String name;
  30. }

响应码枚举对象-ResponseCode

  1. package com.test.invoice.enums;
  3. /**
  4.  * 响应码枚举对象。
  5.  *
  6.  * @author
  7.  */
  8. public enum ResponseCode {
  9.     //通用
  10.     OK(2000, "Success"),
  11.     INSERT_ERROR(-108, "新增失败"),
  12.     DELETE_ERROR(-109, "数据删除失败，请刷新重试"),
  13.     UPDATE_ERROR(-107, "更新失败，请刷新重试"),
  14.     OPERATE_ERROR(5500, "操作失败"),
  15.     PARAM_INVALID(1000, "缺失参数或无效"),
  16.     THIRD_PARTY_EXCEPTION(3000, "第三方接口异常"),
  17.     SYSTEM_EXCEPTION(5000, "系统异常"),
  18.     SYSTEM_EXCEPTION_4(8004, "解析回调的xml出现异常"),
  19.     SYSTEM_EXCEPTION_8(8008, "JSON转换错误"),
  20.     SYSTEM_EXCEPTION_9(8009, "HTTP请求异常"),
  21.     SYSTEM_EXCEPTION_10(8010, "用户权限不够"),
  22.     SYSTEM_EXCEPTION_11(8011, "获取用户信息失败"),
  23.     SYSTEM_EXCEPTION_13(8013, "查询用户出现异常"),
  24.     SYSTEM_EXCEPTION_14(8014, "获取用户信息失败,请核实用户id"),
  25.     SYSTEM_EXCEPTION_16(8888, "获取用户信息失败,请核实用户id"),
  26.     SYSTEM_EXCEPTION_18(8888, "用户权限不够"),
  27.     SYSTEM_EXCEPTION_20(8888, "获取用户信息失败"),
  28.     SYSTEM_EXCEPTION_21(8888, "调用失败"),
  29.     ACCESS_TOKEN_EXCEPTION(9000, "获取token失败"),
  30.     AUTH_INVALID(4000, "身份验证失败"),
  31.     TOKEN_MISSING(4001, "token缺失"),
  32.     TOKEN_INVALID(4002, "token Fail"),
  35.     ;
  37.     private final int value;
  38.     private final String description;
  40.     ResponseCode(int value, String description) {
  41.         this.value = value;
  42.         this.description = description;
  43.     }
  45.     public int value() {
  46.         return this.value;
  47.     }
  49.     public String getDescription() {
  50.         return this.description;
  51.     }
  53.     public static ResponseCode valueOf(int code) {
  54.         for (ResponseCode responseCode : values()) {
  55.             if (responseCode.value == code) {
  56.                 return responseCode;
  57.             }
  58.         }
  59.         throw new IllegalArgumentException("No matching constant for [" + code + "]");
  60.     }
  62.     @Override
  63.     public String toString() {
  64.         return Integer.toString(this.value);
  65.     }
  67. }

服务异常类-ServiceException

  1. package com.test.invoice.excepiton;
  3. import com.test.invoice.enums.ResponseCode;
  5. /**
  6.  * 服务异常类
  7.  *
  8.  * @author:
  9.  * @version:
  10.  * @date: 2019-08-09 10:28
  11.  */
  12. public class ServiceException extends RuntimeException {
  13.     private int code;
  15.     public ServiceException(ResponseCode responseCode,Throwable cause){
  16.         super(responseCode.getDescription(),cause);
  17.         this.code = responseCode.value();
  18.     }
  20.     public  ServiceException(ResponseCode responseCode){
  21.         super(responseCode.getDescription());
  22.         this.code = responseCode.value();
  23.     }
  25.     public int getCode() { return code; }
  27.     public void setCode(int code) { this.code = code; }
  28. }

响应实体-ResponseVO

VO：value object 值对象/ view object 表现层对象
1.主要对应页面显示（web 页面 / swt 、swing 界面）的数据对象
2.可以和表对应，也可以不对应，根据业务需要。 

  1. package com.test.invoice.vo;
  3. import com.fasterxml.jackson.annotation.JsonInclude;
  4. import com.test.invoice.enums.ResponseCode;
  5. import com.test.invoice.excepiton.ServiceException;
  6. import io.swagger.annotations.ApiModel;
  7. import io.swagger.annotations.ApiModelProperty;
  8. import lombok.AllArgsConstructor;
  9. import lombok.Data;
  10. import lombok.NoArgsConstructor;
  11. import lombok.experimental.Accessors;
  13. import java.io.Serializable;
  15. /**
  16.  * 响应实体
  17.  *
  18.  * @author:
  19.  * @version:
  20.  * @date: 2019-08-09 10:40
  21.  */
  22. @Data
  23. @AllArgsConstructor
  24. @NoArgsConstructor
  25. @JsonInclude(JsonInclude.Include.NON_NULL)
  26. @ApiModel("响应实体")
  27. @Accessors(chain = true)
  28. public class ResponseVO<T> implements Serializable {
  29.     private static final long serialVersionUID = 1L;
  31.     @ApiModelProperty("编码 200:成功，其他异常")
  32.     private Integer code;
  34.     @ApiModelProperty("消息")
  35.     private String msg;
  37.     @ApiModelProperty("数据结果集")
  38.     private T data;
  40.     @ApiModelProperty("服务器时间戳")
  41.     private Long timestamp;
  43.     public ResponseVO(ResponseCode responseCode){
  44.         this.code = responseCode.value();
  45.         this.msg = responseCode.getDescription();
  46.         this.timestamp = System.currentTimeMillis();
  47.     }
  49.     public ResponseVO(ResponseCode responseCode,T data){
  50.         this.code = responseCode.value();
  51.         this.msg = responseCode.getDescription();
  52.         this.timestamp = System.currentTimeMillis();
  53.         this.data = data;
  54.     }
  56.     public ResponseVO(ServiceException e){
  57.         this.code = e.getCode();
  58.         this.msg = e.getMessage();
  59.     }
  61.     public ResponseVO(int code, String msg){
  62.         this.code = code;
  63.         this.msg = msg;
  64.         this.timestamp = System.currentTimeMillis();
  65.     }
  66. }

创建子模块-test-invoice-contract

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-contract

模块名称 test-invoice-contract

创建包重复问题

新建包 com.test.invoice.service

再建一个子包 db

再建一个和 db 包同级的包 test

这时候发现并不同级

解决

新建好包 com.test.invoice.service 之后创建类 Test，再创建包

新建类-TRbtTestConsumer

  1. package com.test.invoice.service.consumer;
  3. import org.springframework.cloud.openfeign.FeignClient;
  4. import org.springframework.web.bind.annotation.*;
  6. import com.test.invoice.data.TRbtTestData;
  8. /**
  9.  * TRbtTestConsumer
  10.  *
  11.  * @author:
  12.  * @version:
  13.  * @date: 2019-08-08 14:45
  14.  */
  15. @FeignClient(value = "service-producer")
  16. public class TRbtTestConsumer {
  17.     public void Test()
  18.     {
  19.         TRbtTestData data = new TRbtTestData();
  20.     }
  21. }

pom.xml 引用

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-contract</artifactId>
  13.     <name>test-invoice-contract</name>
  15.     <dependencies>
  16.         <dependency>
  17.             <groupId>com.test.invoice</groupId>
  18.             <artifactId>test-invoice-common</artifactId>
  19.             <version>1.0-SNAPSHOT</version>
  20.         </dependency>
  21.         <!--feign start-->
  22.         <dependency>
  23.             <groupId>org.springframework.cloud</groupId>
  24.             <!--spring boot 2.0.3版本解决方案：spring-cloud-starter-feign-->
  25.             <artifactId>spring-cloud-starter-openfeign</artifactId>
  26.         </dependency>
  27.         <!--feign end-->
  28.     </dependencies>
  30.     <build>
  31.     </build>
  33.     <properties>
  34.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  35.     </properties>
  37. </project>

报错-Dependency ‘xxx’ not found 及解决

  1. Dependency 'com.test.invoice:test-invoice-common:1.0-SNAPSHOT' not found

参考文档

maven多module项目的引用问题

我对比三个 pom.xml 文件

test-invoice-cloud
pom.xml 

  1. <modelVersion>4.0.0</modelVersion>
  2. <groupId>com-test-invoice</groupId>
  3. <artifactId>test-invoice-cloud</artifactId>
  4. <version>1.0-SNAPSHOT</version>
  5. <name>test-invoice-cloud</name>
  6. <packaging>pom</packaging>

test-invoice-common
pom.xml 

  1. <parent>
  2.     <artifactId>test-invoice-cloud</artifactId>
  3.     <groupId>com-test-invoice</groupId>
  4.     <version>1.0-SNAPSHOT</version>
  5. </parent>
  6. <modelVersion>4.0.0</modelVersion>
  7. <artifactId>test-invoice-common</artifactId>
  8. <name>test-invoice-common</name>

test-invoice-contract
pom.xml 

  1. <parent>
  2.     <artifactId>test-invoice-cloud</artifactId>
  3.     <groupId>com-test-invoice</groupId>
  4.     <version>1.0-SNAPSHOT</version>
  5. </parent>
  6. <modelVersion>4.0.0</modelVersion>
  7. <artifactId>test-invoice-contract</artifactId>
  8. <name>test-invoice-contract</name>
  9. <dependency>
  10.     <groupId>com.test.invoice</groupId>
  11.     <artifactId>test-invoice-common</artifactId>
  12.     <version>1.0-SNAPSHOT</version>
  13. </dependency>

问题原因

  1. <dependency>
  2.     <groupId>com.test.invoice</groupId>

问题解决，修改为

  1. <dependency>
  2.     <groupId>com-test-invoice</groupId>

创建下图中的类和文件

模块简介

主要用于提供接口，还有 Feign-api 接口

类图

pom.xml

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-contract</artifactId>
  13.     <name>test-invoice-contract</name>
  15.     <dependencies>
  16.         <dependency>
  17.             <groupId>com-test-invoice</groupId>
  18.             <artifactId>test-invoice-common</artifactId>
  19.             <version>1.0-SNAPSHOT</version>
  20.         </dependency>
  21.         <!--feign start-->
  22.         <dependency>
  23.             <groupId>org.springframework.cloud</groupId>
  24.             <!--spring boot 2.0.3版本解决方案：spring-cloud-starter-feign-->
  25.             <artifactId>spring-cloud-starter-openfeign</artifactId>
  26.         </dependency>
  27.         <!--feign end-->
  28.     </dependencies>
  30.     <build>
  31.     </build>
  33.     <properties>
  34.         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  35.     </properties>
  37. </project>

接口定义-ITRbtTestService

  1. package com.test.invoice.service.producer;
  3. import com.test.invoice.data.TRbtTestData;
  4. import com.test.invoice.data.TRbtTestDataParam;
  5. import com.test.invoice.vo.ResponseVO;
  6. import org.springframework.web.bind.annotation.RequestBody;
  7. import org.springframework.web.bind.annotation.*;
  8. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  10. /**
  11.  * 接口定义-ITRbtTestService
  12.  */
  13. public interface ITRbtTestService {
  14.     ResponseVO<String> Add(@RequestBody TRbtTestData data);
  16.     ResponseVO<Boolean> Update(@RequestBody TRbtTestData data);
  18.     ResponseVO<Boolean> Del(@RequestParam(value="name",required = true) String name,@RequestParam(value="version",required = true) String version);
  20.     ResponseVO<TRbtTestData> Get(@RequestBody TRbtTestData data);
  22.     ResponseVO<Page<TRbtTestData>> Query(@RequestBody TRbtTestDataParam param);
  23. }

Feign-api 接口定义——TRbtTestConsumer

  1. package com.test.invoice.service.consumer;
  3. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  4. import com.test.invoice.vo.ResponseVO;
  5. import org.springframework.cloud.openfeign.FeignClient;
  6. import org.springframework.web.bind.annotation.*;
  8. import com.test.invoice.data.TRbtTestData;
  9. import com.test.invoice.data.TRbtTestDataParam;
  11. /**
  12.  * Feign-api 接口定义——TRbtTestConsumer
  13.  *
  14.  * @author:
  15.  * @version:
  16.  * @date: 2019-08-08 14:45
  17.  */
  18. @FeignClient(value = "service-producer")
  19. public interface TRbtTestConsumer {
  20.     @PostMapping("/Test/Add")
  21.     ResponseVO<String> Add(@RequestBody TRbtTestData data);
  23.     @PostMapping("Test/Update")
  24.     ResponseVO<Boolean> Update(@RequestBody TRbtTestData data);
  26.     @RequestMapping(value="Test/Del",method=RequestMethod.GET)
  27.     ResponseVO<Boolean> Del(@RequestParam(value="name",required = true) String name,@RequestParam(value="version",required = true) String version);
  29.     @PostMapping("/Test/Get")
  30.     ResponseVO<TRbtTestData> Get(@RequestBody TRbtTestData data);
  32.     @PostMapping("/Test/Query")
  33.     ResponseVO<Page<TRbtTestData>> Query(@RequestBody TRbtTestDataParam param);
  34. }

创建子模块-test-invoice-service

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-service

模块名称 test-invoice-service

创建下图中的类和文件

模块简介

作为一个 Eureka Client 模块

实现 test-invoice-contract 项目中定义的接口

类图

pom.xml

  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>test-invoice-cloud</artifactId>
  7.         <groupId>com-test-invoice</groupId>
  8.         <version>1.0-SNAPSHOT</version>
  9.     </parent>
  11.     <modelVersion>4.0.0</modelVersion>
  12.     <artifactId>test-invoice-service</artifactId>
  13.     <name>test-invoice-service</name>
  15.     <dependencies>
  16.         <dependency>
  17.             <groupId>com-test-invoice</groupId>
  18.             <artifactId>test-invoice-contract</artifactId>
  19.             <version>1.0-SNAPSHOT</version>
  20.         </dependency>
  22.         <!--Apache PDFbox 是一个开源的、基于 Java 的、支持 PDF 文档生成的工具库-->
  23.         <dependency>
  24.             <groupId>org.apache.pdfbox</groupId>
  25.             <artifactId>fontbox</artifactId>
  26.             <version>2.0.1</version>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.apache.pdfbox</groupId>
  30.             <artifactId>pdfbox</artifactId>
  31.             <version>2.0.4</version>
  32.         </dependency>
  34.         <!--iText是一个能够快速产生PDF文件的java类库-->
  35.         <dependency>
  36.             <groupId>com.lowagie</groupId>
  37.             <artifactId>itext</artifactId>
  38.             <version>2.1.7</version>
  39.         </dependency>
  42.         <!--mysql start-->
  43.         <dependency>
  44.             <groupId>mysql</groupId>
  45.             <artifactId>mysql-connector-java</artifactId>
  46.         </dependency>
  47.         <!--mysql end-->
  49.         <!--保存到数据库需要如下依赖-->
  50.         <!--<dependency>
  51.             <groupId>mysql</groupId>
  52.             <artifactId>mysql-connector-java</artifactId>
  53.         </dependency>
  54.         <dependency>
  55.             <groupId>org.springframework.boot</groupId>
  56.             <artifactId>spring-boot-starter-jdbc</artifactId>
  57.         </dependency>-->
  60.         <!--db start-->
  61.         <!--号称性能最好的JDBC连接池-->
  62.         <dependency>
  63.             <groupId>com.zaxxer</groupId>
  64.             <artifactId>HikariCP</artifactId>
  65.             <version>${HikariCP.version}</version>
  66.         </dependency>
  67.         <!--db end-->
  69.         <dependency>
  70.             <groupId>com.baomidou</groupId>
  71.             <artifactId>mybatis-plus-boot-starter</artifactId>
  72.             <version>${mybatis-plus-spring-boot-starter.version}</version>
  73.         </dependency>
  75.         <dependency>
  76.             <groupId>org.apache.commons</groupId>
  77.             <artifactId>commons-pool2</artifactId>
  78.         </dependency>
  80.         <!--redis start-->
  81.         <dependency>
  82.             <groupId>org.springframework.boot</groupId>
  83.             <artifactId>spring-boot-starter-data-redis</artifactId>
  84.         </dependency>
  85.         <!--redis end-->
  86.         <!--分布式链路追踪三个依赖-->
  87.         <!--<dependency>
  88.             <groupId>org.springframework.cloud</groupId>
  89.             <artifactId>spring-cloud-starter-sleuth</artifactId>
  90.         </dependency>
  91.         <dependency>
  92.             <groupId>org.springframework.boot</groupId>
  93.             <artifactId>spring-boot-starter-webflux</artifactId>
  94.         </dependency>-->
  95.         <dependency>
  96.             <groupId>org.springframework.cloud</groupId>
  97.             <artifactId>spring-cloud-starter-zipkin</artifactId>
  98.         </dependency>
  100.         <!--activiti start-->
  101.         <dependency>
  102.             <groupId>org.activiti</groupId>
  103.             <artifactId>activiti-spring-boot-starter-basic</artifactId>
  104.             <version>6.0.0</version>
  105.         </dependency>
  106.         <!--activiti end-->
  107.     </dependencies>
  109.     <build>
  110.         <finalName>${project.artifactId}</finalName>
  111.         <plugins>
  112.             <plugin>
  113.                 <groupId>org.springframework.boot</groupId>
  114.                 <artifactId>spring-boot-maven-plugin</artifactId>
  115.                 <configuration>
  116.                     <fork>true</fork>
  117.                 </configuration>
  118.                 <!--如果要访问info接口想获取maven中的属性内容请记得添加如下内容-->
  119.                 <executions>
  120.                     <execution>
  121.                         <goals>
  122.                             <goal>build-info</goal>
  123.                         </goals>
  124.                     </execution>
  125.                 </executions>
  126.             </plugin>
  127.         </plugins>
  128.         <resources>
  129.             <resource>
  130.                 <directory>src/main/resources</directory>
  131.                 <includes>
  132.                     <include>**/*</include>
  133.                 </includes>
  134.             </resource>
  135.         </resources>
  136.     </build>
  137. </project>

Resources

自定义分页映射xml-TRbtTestMapper.xml

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
  3. <mapper namespace="com.test.invoice.mapper.TRbtTestRepository">
  4.     <select id="selectPageVO" resultType="com.test.invoice.data.TRbtTestData"
  5.             parameterType="com.test.invoice.data.TRbtTestDataParam">
  6.         select id,name,version from t_rbt_test where name = #{param.name}
  7.     </select>
  8. </mapper>

application.yml

  1. server:
  2.   port: 18800
  4. spring:
  5.   profiles:
  6.     active: dev # 指定配置文件
  7.   http:
  8.     encoding:
  9.       force: true # 默认编码，即 utf8
  10.   activiti:
  11.     check-process-definitions: false # 校验流程文件，默认校验resources下的processes文件夹里的流程文件
  12.   # 服务名称，即serviceId
  13.   application:
  14.     name: service-producer
  15.   sleuth:
  16.     web:
  17.       client:
  18.         enabled: true # 启用为分布式web client 客户端
  19.     sampler:
  20.       probability: 1.0 # 将采样比例设置为 1.0，也就是全部都需要。默认是 0.1

application-dev.yml

  1. spring:
  2.   datasource:
  3.     type: com.zaxxer.hikari.HikariDataSource #数据源类型
  4.     url: jdbc:mysql://localhost:3306/luoma_test?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false #数据库url
  5.     username: root        #数据库用户名
  6.     password: luoma_LUOMA #数据库密码
  8.     driver-class-name: com.mysql.jdbc.Driver #数据库驱动
  9.     hikari:
  10.       pool-name: pool-vscloud
  11.       connectionTestQuery: SELECT 1
  12.       maximum-pool-size: 50
  13.       minimum-idle: 10
  15. #mybatis
  16. mybatis-plus:
  17.   mapper-locations: classpath:/mapper/*Mapper.xml #mybatis-plus mapper xml 文件地址
  18.   #实体扫描,多个package用逗号或者分号分隔
  19.   typeAliasesPackage:
  20.   typeEnumsPackage:
  21.   global-config:
  22.     id-type: 4
  23.     #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
  24.     field-strategy: 2
  25.     #驼峰下划线转换
  26.     db-column-underline: true
  27.     #刷新mapper 调试神器
  28.     refresh-mapper: true
  29.     #数据库大写下划线转换
  30.     #capital-mode: true
  31.     #序列接口实现类配置
  32.     #key-generator:
  33.     #逻辑删除配置
  34.     logic-delete-value: 0
  35.     logic-not-delete-value: 1
  36.   configuration:
  37.     map-underscore-to-camel-case: true
  38.     cache-enabled: false
  40. # 服务注册与发现相关配置
  41. eureka:
  42.   #自定义实例编号
  43.   instance:
  44.     instance-id: ${spring.application.name}:${server.port}
  45.     # 优先使用IP地址方式进行注册服务
  46.     prefer-ip-address: true
  47.     # 配置使用指定IP
  48.   client:
  49.     # 服务注册地址
  50.     serviceUrl:
  51.       defaultZone: http://127.0.0.1:8772/eureka/

application-test.yml

  1. #spring
  2. spring:
  3.   datasource:
  4.     type: com.zaxxer.hikari.HikariDataSource
  5.     url: jdbc:mysql://localhost:3306/luoma_test?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false
  6.     username: root
  7.     password: luoma_ai_LEIMU
  9.     driver-class-name: com.mysql.jdbc.Driver
  10.     hikari:
  11.       pool-name: pool-vscloud
  12.       connectionTestQuery: SELECT 1
  13.       maximum-pool-size: 50
  14.       minimum-idle: 10
  16. #mybatis
  17. mybatis-plus:
  18.   mapper-locations: classpath:/mapper/*Mapper.xml
  19.   #实体扫描,多个package用逗号或者分号分隔
  20.   typeAliasesPackage:
  21.   typeEnumsPackage:
  22.   global-config:
  23.     #主键类型  0:"数据库ID自增", 1:"用户输入ID",2:"全局唯一ID (数字类型唯一ID)", 3:"全局唯一ID UUID";
  24.     id-type: 0
  25.     #字段策略 0:"忽略判断",1:"非 NULL 判断"),2:"非空判断"
  26.     field-strategy: 2
  27.     #驼峰下划线转换
  28.     db-column-underline: true
  29.     #刷新mapper 调试神器
  30.     refresh-mapper: true
  31.     #数据库大写下划线转换
  32.     #capital-mode: true
  33.     #序列接口实现类配置
  34.     #key-generator:
  35.     #逻辑删除配置
  36.     logic-delete-value: 0
  37.     logic-not-delete-value: 1
  38.   #    #自定义填充策略接口实现
  39.   #    meta-object-handler:
  40.   configuration:
  41.     map-underscore-to-camel-case: true
  42.     cache-enabled: false

bootstrap.properties

  1. #由于 logback-spring.xml的加载在 application.properties之前，所以之前的配置 logback-spring.xml无法获取到 spring.application.name属性，因此这里将该属性移动到最先加载的 bootstrap.properties配置文件中。
  2. #https://cloud.tencent.com/developer/article/1067431
  4. spring.application.name=service-producer

MybatisPlus 配置类-MybatisPlusConfig

  1. package com.test.invoice.config;
  3. import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
  4. import com.baomidou.mybatisplus.extension.plugins.PerformanceInterceptor;
  5. import org.mybatis.spring.mapper.MapperScannerConfigurer;
  6. import org.springframework.context.annotation.Bean;
  7. import org.springframework.context.annotation.Configuration;
  8. import org.springframework.context.annotation.Profile;
  10. /**
  11.  * 从Spring3.0，@Configuration用于定义配置类，可替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描，并用于构建bean定义，初始化Spring容器。
  12.  */
  13. @Configuration
  14. public class MybatisPlusConfig {
  16.     /**
  17.      * mybatis-plus SQL执行效率插件【生产环境可以关闭】
  18.      */
  19.     @Bean
  20.     //@Profile({"dev", "test"})// 设置 dev test 环境开启
  21.     @Profile({"dev"})// 设置 dev test 环境开启
  22.     public PerformanceInterceptor performanceInterceptor() {
  23.         return new PerformanceInterceptor();
  24.     }
  26.     /**
  27.      * mybatis-plus分页插件<br>
  28.      * 文档：http://mp.baomidou.com<br>
  29.      */
  30.     @Bean
  31.     public PaginationInterceptor paginationInterceptor() {
  32.         PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
  33.         // paginationInterceptor.setLimit(你的最大单页限制数量，默认 500 条，小于 0 如 -1 不受限制);
  34.         return paginationInterceptor;
  35.     }
  37.     /**
  38.      * 相当于顶部的：
  39.      * {@code @MapperScan("com.baomidou.springboot.mapper*")}
  40.      * 这里可以扩展，比如使用配置文件来配置扫描Mapper的路径
  41.      */
  42.     @Bean
  43.     public MapperScannerConfigurer mapperScannerConfigurer() {
  44.         MapperScannerConfigurer scannerConfigurer = new MapperScannerConfigurer();
  45.         scannerConfigurer.setBasePackage("com.test.invoice.mapper*");
  46.         return scannerConfigurer;
  47.     }
  48. }

MybatisPlus 配置类-MyMetaObjectHandler

  1. package com.test.invoice.config;
  4. import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
  5. import lombok.extern.slf4j.Slf4j;
  6. import org.apache.ibatis.reflection.MetaObject;
  7. import org.springframework.stereotype.Component;
  9. import java.util.Date;
  11. /**
  12.  * mybatis公共字段自动填充
  13.  *
  14.  */
  15. @Slf4j
  16. @Component
  17. public class MyMetaObjectHandler implements MetaObjectHandler {
  19.     @Override
  20.     public void insertFill(MetaObject metaObject) {
  21.         String user="luoma";
  22.         try {
  23.             log.info("【填充数据 --开始】");
  24.             this.setFieldValByName("createTime", new Date(), metaObject);
  25.             this.setFieldValByName("updateTime", new Date(), metaObject);
  26.             this.setFieldValByName("bizTime", new Date(), metaObject);
  27.             this.setFieldValByName("isDelete", 0, metaObject);
  28.             this.setFieldValByName("createBy", user, metaObject);
  29.             this.setFieldValByName("updateBy", user, metaObject);
  30.             log.info("【填充数据 --完毕】");
  31.         } catch (Exception e) {
  32.             log.info("填充错误" + e.getMessage());
  33.         }
  34.     }
  36.     /**
  37.      * description 更新自动填充
  38.      */
  39.     @Override
  40.     public void updateFill(MetaObject metaObject) {
  41.         String user="luoma";
  42.         this.setFieldValByName("updateTime", new Date(), metaObject);
  43.         this.setFieldValByName("bizTime", new Date(), metaObject);
  44.         this.setFieldValByName("updateBy", user, metaObject);
  45.         log.info("【填充数据 --完毕】");
  46.     }
  47. }

自定义接口-TRbtTestRepository

  1. package com.test.invoice.mapper;
  3. import com.baomidou.mybatisplus.core.mapper.BaseMapper;
  4. import com.baomidou.mybatisplus.core.metadata.IPage;
  5. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  6. import com.test.invoice.data.TRbtTestData;
  7. import com.test.invoice.data.TRbtTestDataParam;
  8. import com.test.invoice.model.TRbtTestEntity;
  9. import org.springframework.stereotype.Repository;
  11. @Repository
  12. public interface TRbtTestRepository extends BaseMapper<TRbtTestEntity> {
  13.     IPage<TRbtTestData> selectPageVO(Page<TRbtTestData> page, TRbtTestDataParam param);
  14. }

接口实现-TRbtTestServiceImpl

  1. package com.test.invoice.service.impl;
  3. import com.test.invoice.data.TRbtTestDataParam;
  4. import com.test.invoice.enums.ResponseCode;
  5. import com.test.invoice.vo.ResponseVO;
  6. import com.test.invoice.data.TRbtTestData;
  7. import com.test.invoice.mapper.TRbtTestRepository;
  8. import com.test.invoice.model.TRbtTestEntity;
  9. import com.test.invoice.service.producer.ITRbtTestService;
  12. import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
  13. import com.baomidou.mybatisplus.core.metadata.IPage;
  14. import com.baomidou.mybatisplus.core.toolkit.Wrappers;
  15. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  16. import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
  17. import lombok.extern.slf4j.Slf4j;
  18. import org.springframework.stereotype.Service;
  19. import org.springframework.web.bind.annotation.RequestBody;
  20. import org.springframework.web.bind.annotation.RequestParam;
  22. import java.util.List;
  25. /**
  26.  * TRbtTestServiceImpl
  27.  *
  28.  * @author:
  29.  * @version:
  30.  * @date: 2019-08-12 10:23
  31.  */
  32. @Slf4j
  33. @Service
  34. public class TRbtTestServiceImpl extends ServiceImpl<TRbtTestRepository, TRbtTestEntity> implements ITRbtTestService {
  35.     @Override
  36.     public ResponseVO<String> Add(@RequestBody TRbtTestData data){
  37.         TRbtTestEntity entity = new TRbtTestEntity();
  38.         entity.setName(data.getName()).setVersion(data.getVersion());
  39.         if(baseMapper.insert(entity) > 0){
  40.             return new ResponseVO<>(ResponseCode.OK);
  41.         }
  42.         return new ResponseVO<>(ResponseCode.OPERATE_ERROR,"ERROR");
  43.     }
  45.     @Override
  46.     public ResponseVO<Boolean> Update(@RequestBody TRbtTestData data){
  47.         UpdateWrapper<TRbtTestEntity> wrapper = new UpdateWrapper<>();
  48.         wrapper.set("name",data.getName()).set("version",data.getVersion());
  49.         wrapper.eq("id",data.getId());
  50.         return new ResponseVO<>(ResponseCode.OK,update(wrapper));
  51.     }
  53.     @Override
  54.     public ResponseVO<Boolean> Del(@RequestParam(value="name",required = true) String name, @RequestParam(value="version",required = true) String version){
  55.         UpdateWrapper<TRbtTestEntity> wrapper = new UpdateWrapper<>();
  56.         wrapper.eq("name",name);
  57.         wrapper.eq("version",version);
  58.         return new ResponseVO<>(ResponseCode.OK, baseMapper.delete(wrapper) > 0);
  60.     }
  62.     @Override
  63.     public ResponseVO<TRbtTestData> Get(@RequestBody TRbtTestData data){
  64.         List<TRbtTestEntity> list = baseMapper.selectList(Wrappers.<TRbtTestEntity>lambdaQuery().eq(TRbtTestEntity::getName, data.getName()));
  65.         if(!list.isEmpty()){
  66.             TRbtTestEntity entity = list.get(0);
  67.             data.setName(entity.getName());
  68.             data.setVersion(entity.getVersion());
  69.             return new ResponseVO<>(ResponseCode.OK, data);
  70.         }else{
  71.             return new ResponseVO<>(ResponseCode.PARAM_INVALID, data);
  72.         }
  73.     }
  75.     @Override
  76.     public ResponseVO<Page<TRbtTestData>> Query(@RequestBody TRbtTestDataParam param){
  77.         Page<TRbtTestData> page = new Page<>();
  78.         page.setCurrent(param.getPage());
  79.         page.setSize(param.getPageSize());
  81.         //return new ResponseVO<>(ResponseCode.OK, baseMapper.selectPageVO(page, param));
  84.         IPage<TRbtTestData> ipageData = baseMapper.selectPageVO(page, param);
  86.         //IPage<TRbtTestData> 转换为 Page<TRbtTestData>
  87.         Page<TRbtTestData> pageData = new Page<>();
  88.         pageData.setRecords(ipageData.getRecords());
  89.         pageData.setCurrent(ipageData.getCurrent());
  90.         pageData.setSize(ipageData.getSize());
  91.         pageData.setTotal(ipageData.getTotal());
  93.         return new ResponseVO<>(ResponseCode.OK, pageData);
  94.     }
  95. }

生产者：业务微服务-测试框架系统控制类-TRbtTestController

  1. package com.test.invoice.contorller;
  3. import com.test.invoice.data.TRbtTestData;
  4. import com.test.invoice.data.TRbtTestDataParam;
  5. import com.test.invoice.service.producer.ITRbtTestService;
  6. import com.test.invoice.vo.ResponseVO;
  7. import org.springframework.web.bind.annotation.PostMapping;
  8. import org.springframework.web.bind.annotation.RequestBody;
  9. import org.springframework.web.bind.annotation.RequestMapping;
  10. import org.springframework.web.bind.annotation.RestController;
  11. import io.swagger.annotations.Api;
  12. import io.swagger.annotations.ApiOperation;
  13. import org.springframework.web.bind.annotation.*;
  14. import com.baomidou.mybatisplus.extension.plugins.pagination.Page;
  17. import javax.annotation.Resource;
  19. /**
  20.  *
  21.  * 生产者：业务微服务-测试框架系统控制类
  22.  *
  23.  * @author:
  24.  * @version:
  25.  * @date: 2019-08-12 09:53
  26.  */
  27. @RestController
  28. @Api(description = "测试框架系统控制类")
  29. public class TRbtTestController {
  30.     @Resource
  31.     private ITRbtTestService testService;
  33.     @PostMapping("/Test/Add")
  34.     @ApiOperation(value="系统框架测试-新增数据",httpMethod = "POST",response = ResponseVO.class,notes = "系统框架测试-新增数据")
  35.     public ResponseVO Add(@RequestBody TRbtTestData data){
  36.         return testService.Add(data);
  37.     }
  39.     @PostMapping("Test/Update")
  40.     @ApiOperation(value="系统框架测试-修改数据",httpMethod = "POST",response = ResponseVO.class,notes = "系统框架测试-修改数据")
  41.     public ResponseVO<Boolean> Update(@RequestBody TRbtTestData data){
  42.         return testService.Update(data);
  43.     }
  45.     @RequestMapping(value="Test/Del",method = RequestMethod.GET)
  46.     @ApiOperation(value="系统框架测试-删除数据",httpMethod = "GET",response = ResponseVO.class,notes = "系统框架测试-删除数据")
  47.     public ResponseVO<Boolean> Del(@RequestParam(value="name",required = true) String name,@RequestParam(value="version",required = true) String version)
  48.     {
  49.         return testService.Del(name,version);
  50.     }
  52.     @PostMapping("/Test/Get")
  53.     @ApiOperation(value="系统框架测试-获取单个数据",httpMethod = "POST",response = ResponseVO.class,notes = "系统框架测试-获取单个数据")
  54.     public ResponseVO<TRbtTestData> Get(@RequestBody TRbtTestData data){
  55.         return testService.Get(data);
  56.     }
  58.     @PostMapping("/Test/Query")
  59.     @ApiOperation(value="系统框架测试-查询分页数据",httpMethod = "POST",response = ResponseVO.class,notes = "系统框架测试-查询分页数据")
  60.     public ResponseVO<Page<TRbtTestData>> Query(@RequestBody TRbtTestDataParam param){
  61.         return testService.Query(param);
  62.     }
  63. }

入口类-ServerApplication

  1. package com.test.invoice;
  5. import org.activiti.spring.boot.SecurityAutoConfiguration;
  6. import org.springframework.boot.SpringApplication;
  7. import org.springframework.boot.autoconfigure.SpringBootApplication;
  8. import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
  9. import org.springframework.web.bind.annotation.RestController;
  12. /**
  13.  * 启动类
  14.  *
  15.  * @author:
  16.  * @version:
  17.  * @date: 2019-08-12 09:53
  18.  */
  19. @SpringBootApplication(exclude = SecurityAutoConfiguration.class) //禁用 security 验证
  20. @RestController
  21. @EnableEurekaClient //Eureka Client
  22. public class ServerApplication {
  23.     public static void main(String[] args){
  24.         SpringApplication.run(ServerApplication.class,args);
  25.     }
  26. }

测试结果

启动项目 test-invoice-eureka
启动项目 test-invoice-service

启动多个项目参考

启动多个项目

首先访问 http://localhost:8772/ ，看 Instances currently registered with Eureka 是否能看到 test-invoice-service 项目

接着使用 Postman 调用 test-invoice-service 接口 Add

结果

创建子模块-test-invoice-web

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-web

模块名称 test-invoice-web

创建下图中的类和文件

模块简介

作为一个 Eureka 客户端，提供调用接口

类图

pom.xml

  1. server:
  2.   port: 8080
  3.   servlet:
  4.     context-path: /enta/api
  6. spring:
  7.   application:
  8.     # 服务名，即serviceId
  9.     name: service-feign-web
  10.   sleuth:
  11.     web:
  12.       client:
  13.         enabled: true # 启用为分布式web client 客户端
  14.     sampler:
  15.       probability: 1.0 # 将采样比例设置为 1.0，也就是全部都需要。默认是 0.1
  18. # 服务注册与发现相关配置
  19. eureka:
  20.   #自定义实例编号
  21.   instance:
  22.     instance-id: ${spring.application.name}:${server.port}
  23.     # 优先使用IP地址方式进行注册服务
  24.     prefer-ip-address: true
  25.     # 配置使用指定IP
  26.     # ip-address: 127.0.0.1
  27.   client:
  28.     # 服务注册地址
  29.     serviceUrl:
  30.       #      defaultZone: http://127.0.0.1:8772/eureka/
  31.       defaultZone: http://127.0.0.1:8772/eureka/
  33. #配置actuator的相关配置
  34. # 描述信息
  35. info:
  36.   blog-url: http://luoma.pro
  37.   author: luoma
  40. # 加载所有的端点/默认只加载了 info / health
  41. management:
  42.   endpoints:
  43.     web:
  44.       exposure:
  45.         include: "*"
  46.   endpoint:
  47.     health:
  48.       show-details: always
  49.     shutdown:
  50.       enabled: false # 可以关闭制定的端点

bootstrap.properties

  1. #由于 logback-spring.xml的加载在 application.properties之前，所以之前的配置 logback-spring.xml无法获取到 spring.application.name属性，因此这里将该属性移动到最先加载的 bootstrap.properties配置文件中。
  2. #https://cloud.tencent.com/developer/article/1067431
  4. spring.application.name=service-feign-web

消费者，通过 Feign-api 调用-TRbtTestController

  1. package com.test.invoice.controller;
  3. import com.test.invoice.data.TRbtTestData;
  4. import com.test.invoice.data.TRbtTestDataParam;
  5. import com.test.invoice.service.consumer.TRbtTestConsumer;
  6. import com.test.invoice.vo.ResponseVO;
  7. import io.swagger.annotations.Api;
  8. import io.swagger.annotations.ApiOperation;
  9. import org.springframework.web.bind.annotation.*;
  10. import org.springframework.beans.factory.annotation.Autowired;
  13. /**
  14.  * 消费者，通过 Feign-api 调用
  15.  *
  16.  * @author:
  17.  * @version:
  18.  * @date: 2019-08-12 14:49
  19.  */
  20. @RestController
  21. @Api(description = "测试框架系统控制类")
  22. @RequestMapping("/Inv/Api")
  23. public class TRbtTestController {
  24.     //@Resource
  25.     @Autowired
  26.     private TRbtTestConsumer testConsumer;
  28.     @PostMapping("Test/Add")
  29.     @ApiOperation(value = "系统框架测试-新增数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-新增数据")
  30.     public ResponseVO Add(@RequestBody TRbtTestData data){
  31.         return testConsumer.Add(data);
  32.     }
  34.     @PostMapping("Test/Update")
  35.     @ApiOperation(value = "系统框架测试-修改数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-修改数据")
  36.     public ResponseVO Update(@RequestBody TRbtTestData data){
  37.         return testConsumer.Update(data);
  38.     }
  40.     @RequestMapping(value="Test/Del",method=RequestMethod.GET)
  41.     @ApiOperation(value = "系统框架测试-删除数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-删除数据")
  42.     public ResponseVO Del(@RequestParam(value="name",required = true) String name,@RequestParam(value="version",required = true) String version){
  43.         return testConsumer.Del(name,version);
  44.     }
  46.     @PostMapping("/Test/Get")
  47.     @ApiOperation(value = "系统框架测试-获取单个数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-获取单个数据")
  48.     public ResponseVO Get(@RequestBody TRbtTestData data){
  49.         return testConsumer.Get(data);
  50.     }
  52.     @PostMapping("/Test/Query")
  53.     @ApiOperation(value = "系统框架测试-获取分页数据", httpMethod = "POST", response = ResponseVO.class, notes = "系统框架测试-获取分页数据")
  54.     public ResponseVO Query(@RequestBody TRbtTestDataParam param){
  55.         return testConsumer.Query(param);
  56.     }
  57. }

启动类-WebApplication

  1. package com.test.invoice;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
  6. import org.springframework.cloud.openfeign.EnableFeignClients;
  9. /**
  10.  * 启动类
  11.  *
  12.  * @author:
  13.  * @version:
  14.  * @date: 2019-08-12 14:43
  15.  */
  16. //禁用 security 验证
  17. @SpringBootApplication(exclude = org.springframework.boot.autoconfigure.security.servlet.SecurityAutoConfiguration.class)
  18. @EnableFeignClients //使用feign客户端,https://blog.csdn.net/andy_zhang2007/article/details/86680622
  19. @EnableEurekaClient //启用服务注册与发现
  20. public class WebApplication  { //extends SpringBootServletInitializer
  21.     public static void main(String[] args){
  22.         SpringApplication.run(WebApplication.class,args);
  23.     }
  24. }

测试

启动项目 test-invoice-eureka
启动项目 test-invoice-service
启动项目 test-invoice-web

启动多个项目参考

启动多个项目

首先访问 http://localhost:8772/ ，看 Instances currently registered with Eureka 是否能看到

test-invoice-service 项目
test-invoice-web 项目

测试-Add

使用 Postman 访问 http://localhost:8080/enta/api/Inv/Api/Test/Add

参数

  1. {"id":"","name":"luoma","version":"1.0.6"}

结果

测试-Update

使用 Postman 访问 http://localhost:8080/enta/api/Inv/Api/Test/Update

参数

  1. {"id":"11d1dd6b2bbe1d9a729986f5c2f62b42","name":"测试数据-菲克-1","version":"1.0.1"}

结果

测试-Del

使用 Postman 访问 http://localhost:8080/enta/api/Inv/Api/Test/Del?name=luoma&version=1.0.1

结果

测试-Get

使用 Postman 访问 http://localhost:8080/enta/api/Inv/Api/Test/Get

参数

  1. {"id":"","name":"测试数据-菲克-1","version":""}

测试-Query

使用 Postman 访问 http://localhost:8080/enta/api/Inv/Api/Test/Query

参数

  1. {"page":2,"pageSize":3,"name":"luoma"}

项目开发过程中遇到的问题及解决

创建包重复问题

父模块 pom.xml 引入包子模块 pom.xml 无法解析问题

访问接口-提示 Unsupported Media Type

启动 Spring Boot 项目访问接口提示 Login with Username and Password

无法构造’com.baomidou.mybatisplus.core.metadata.ipage’的实例

项目总类图

项目总结构图

扩展-负载均衡

创建子模块-test-invoice-service-1

test-invoice-cloud 上右键，新建模块

左侧面板选择 Maven，不勾选 Create from archetype 选项，如下图，点击 下一个 即可。

artifactId test-invoice-service-1

模块名称 test-invoice-service-1

复制 test-invoice-service 模块的所有内容到 test-invoice-service-1

修改启动类为 ServerApplication_1

  1. package com.test.invoice;
  5. import org.activiti.spring.boot.SecurityAutoConfiguration;
  6. import org.springframework.boot.SpringApplication;
  7. import org.springframework.boot.autoconfigure.SpringBootApplication;
  8. import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
  9. import org.springframework.web.bind.annotation.RestController;
  12. /**
  13.  * 启动类
  14.  *
  15.  * @author:
  16.  * @version:
  17.  * @date: 2019-08-12 09:53
  18.  */
  19. @SpringBootApplication(exclude = SecurityAutoConfiguration.class) //禁用 security 验证
  20. @RestController
  21. @EnableEurekaClient //Eureka Client
  22. public class ServerApplication_1 {
  23.     public static void main(String[] args){
  24.         SpringApplication.run(ServerApplication_1.class,args);
  25.     }
  26. }

修改 TRbtTestServiceImpl 的 Add 方法

原 Add 方法添加代码 data.setName(data.getName()+"_18801"); 以示区分

  1. @Override
  2. public ResponseVO<String> Add(@RequestBody TRbtTestData data){
  3.     data.setName(data.getName()+"_18801");
  4.     TRbtTestEntity entity = new TRbtTestEntity();
  5.     entity.setName(data.getName()).setVersion(data.getVersion());
  6.     if(baseMapper.insert(entity) > 0){
  7.         return new ResponseVO<>(ResponseCode.OK);
  8.     }
  9.     return new ResponseVO<>(ResponseCode.OPERATE_ERROR,"ERROR");
  10. }

修改 application.yml 端口号

端口号从 18800 修改为 18801,其它不变

  1. server:
  2.   port: 18801
  4. spring:
  5.   profiles:
  6.     active: dev # 指定配置文件
  7.   http:
  8.     encoding:
  9.       force: true # 默认编码，即 utf8
  10.   activiti:
  11.     check-process-definitions: false # 校验流程文件，默认校验resources下的processes文件夹里的流程文件
  12.   # 服务名称，即serviceId
  13.   application:
  14.     name: service-producer
  15.   sleuth:
  16.     web:
  17.       client:
  18.         enabled: true # 启用为分布式web client 客户端
  19.     sampler:
  20.       probability: 1.0 # 将采样比例设置为 1.0，也就是全部都需要。默认是 0.1

启动项目

依次启动

  1. 启动项目 `test-invoice-eureka`
  2. 启动项目 `test-invoice-service`
  3. 启动项目 `test-invoice-service-1`
  4. 启动项目 `test-invoice-web`

查看 Eureka 是否注册

访问 http://localhost:8772/

使用 Postman 调用接口

快速的多次点击添加

URL：http://localhost:8080/enta/api/Inv/Api/Test/Add
参数：{"id":"","name":"五哥","version":"1.0.6"}

数据库查询结果

  1. SELECT * FROM `t_rbt_test`
  2. where name like '五哥%'

可以看到有些是正常的数据，有些是带后缀 _18801 的数据

说明两个服务中心 test-invoice-service，test-invoice-service-1 自动提供了服务均衡负载的功能

项目调用关系图

相关附件 test-invoice-cloud | 大小:0.1M | 下载 test-invoice-cloud-负载均衡 | 大小:0.13M | 下载