最近我搭建了一个基于Spring Boot的maven分布式项目框架,主要是用于后面的Spring Cloud微服务项目。我把它抽象出来,分享给大家。
0. 项目介绍
在微服务架构中,传统的 maven 项目已经无法满足,开始走向分布式架构,本项目主要搭建一个空的 maven 分布式架构,可以运用到实际项目中进行扩展。
这里搭建的是基于 maven 的分布式工程,因为在一个项目中,多个微服务是属于同一个工程,只不过是提供不同的服务而已,再加上 IDEA 是默认一个窗口打开一个项目工程(这点和 eclipse 不同),如果项目大,不用 maven 分布式工程(也可以称聚合工程)的话,那估计会打开十几个窗口……会崩溃……而且在架构上,也应该使用 maven 分布式工程来搭建微服务架构。
这里手把手教大家如何在 IDEA 中搭建基于 maven 分布式的 Spring Cloud 微服务工程架构。我会写的非常详细,目的就是让每一位读者能够读懂创建的过程。并且在文章末尾提供源码下载地址。
1. maven分布式工程架构概览
首先来看一下 maven 分布式工程的基本架构,如下:
microservice
---- microservice-common
---- microservice-order-provider
---- microservice-order-consumer
在 IDEA 中,并没有这个结构化的展示,这几个模块都是平级的方式展现在我们眼前,但是彼此有依赖关系,体现在 pom.xml 文件中,我在下文会详细说明。
microservice
为父工程模块,主要用来定义整个分布式工程的依赖版本;
microservice-common
为公共模块,主要用来定义一些公共的组件,比如实体类等;
microservice-order-provider
为订单服务提供者模块,提供订单信息,实际项目中可能还有其他服务提供模块;
microservice-order-consumer
为服务消费模块,当然了,消费模块也可能有很多,这里只创建一个,实际项目中可以在此基础上进行扩展。
2. maven父工程microservice的搭建
打开IDEA,File->New->New Project,然后选择Empty Project,如下。
Next,然后给maven分布式项目起个名儿,如 maven_distributed。
接下来会弹出窗口让我们新建 modules,点击 + 号,新建一个父工程,也就是一个父 module。然后我们选择 maven 工程,选择 jdk 版本和模板,模板也可以不选择,我这里就没有选择,自己搭建即可。
Next,需要输入 GroupId 和 ArtifactId,这和普通的 maven 工程没什么两样,如:
GroupId:com.itcodai
ArtifactId:microservice
创建好之后,该父工程 microservice
是个空的 maven 工程,只有 src 目录和 pom.xml 文件,在父工程中我们主要做什么呢?父工程中主要用来定义一些依赖的版本,子工程在创建的时候继承该父工程,就可以使用对用的依赖,不需要指定版本号。同时,如果有版本相关的修改,只要在父工程中修改即可,这是 maven 分布式工程的好处之一,它就相当于 Java 中的抽象父类。
新创建的空 maven 工程没有指定其 <packaging> 类型,maven 父工程需要指定 packaging 类型为 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 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.itcodai</groupId> <artifactId>microservice</artifactId> <version>1.0-SNAPSHOT</version> <packaging>pom</packaging> </project>
然后我们来定义一些依赖和相应的版本,依赖的版本我们定义在 properties 标签内,如下。
<?xml version="1.0" encoding="UTF-8"?> <project ...> <!-- 省略其他内容 --> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> <spring-cloud.version>Edgware.SR1</spring-cloud.version> <spring-boot.version>2.0.3.RELEASE</spring-boot.version> <mysql.version>5.1.46</mysql.version> <mybatis.version>1.3.2</mybatis.version> <lombok.version>1.16.18</lombok.version> </properties> </prject>
如上,我们定义了项目的编码为 UTF-8,编译版本为 jdk8,其他依赖版本为:
* Spring Cloud 的版本为 Edgware.SR1,Spring Cloud 的版本号定义的非常“奇怪”,不是我们平常看到的几点几版本,它是由地名儿来命名的。
* Spring Boot 版本为当前最新版本 2.0.3.RELEASE。
* mysql 版本为 5.1.14。
* mybatis 版本为 1.3.2。
* lombok版本为 1.16.8。
其他依赖在项目使用到时,再添加即可,这里先定义这么多。在定义版本时,要注意的是不同的依赖版本之间会有影响,有些最新的版本不支持其他依赖的低版本一起使用,比如 mysql 的版本太低就不行,例如 5.0.4 版本就无法和最新的 mybatis 一起使用,这些在实际项目中都踩过坑,所以大家在学习的时候要多尝试,多总结,最新版本不是不好用,有时候是用不好。但是只要认真探索,多踩坑才能进步。
定义了依赖版本之后,接下来我们就在父工程中定义依赖管理,放在 <dependencyManagement> 标签中,如下。
<?xml version="1.0" encoding="UTF-8"?> <project ...> <!-- 省略其他内容 --> <dependencyManagement> <dependencies> <!-- 定义 spring cloud 版本 --> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>${spring-cloud.version}</version> <type>pom</type> <scope>import</scope> </dependency> <!-- 定义 spring boot 版本 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>${spring-boot.version}</version> <type>pom</type> <scope>import</scope> </dependency> <!-- 定义 mysql 版本 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>${mysql.version}</version> </dependency> <!-- 定义 mybatis 版本 --> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>${mybatis.version}</version> </dependency> <!-- 定义 lombok 版本 --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>${lombok.version}</version> </dependency> </dependencies> </dependencyManagement> </project>
使用 ${} 来定义上面 <properties> 标签中定义的版本即可。最后我们定义一下 maven 插件,如下。
<?xml version="1.0" encoding="UTF-8"?> <project ...> <!-- 省略其他内容 --> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>