前言
本篇基于maven来构建微服务项目的基本项目架构,我们知道所谓微服务,即会将多个业务划分成多个项目来处理,如何统一的管理这些项目,maven引出了父子项目的结构,可以方便的给我们提供:
- 统一依赖管理
- 控制插件版本
- 聚合项目
创建父项目
使用STS创建,file->new->other…,选择Maven下的Maven Project,按如下图创建父项目,注意packaging选择pom
:
创建成功后,保留pom.xml即可。在pom中增加SpringCloud、及SpringCloud-alibaba主版本的配置:
<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.mingx</groupId>
<artifactId>mingx-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>pom</packaging>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.5.RELEASE</version>
</parent>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
<spring-cloud-alibaba.version>0.9.0.RELEASE</spring-cloud-alibaba.version>
<lombok.version>1.16.20</lombok.version>
</properties>
<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-cloud-alibaba主版本管理 -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-alibaba-dependencies</artifactId>
<version>${spring-cloud-alibaba.version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<!-- lombok主版本管理 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>${lombok.version}</version>
<scope>provided</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
</dependencies>
</project>
在pom.xml的dependencyManagement标签中已经将后续依赖的Spring Clould版本以及Spring Cloud Alibaba版本。
因为Spring Cloud Alibaba是基于Spring Cloud Common的规范实现的,所以在构建项目时,一定要注意Spingboot、Spring Cloud和Spring Cloud Alibaba三者之间的关系,具体的版本关系如下
SpringClould Version | SpringCloud Alibaba Version | SpringBoot Version |
---|---|---|
Greenwich | 0.9.X.RELEASE | 2.1.X.RELEASE |
Finchley | 0.2.X.RELEASE | 2.0.X.RELEASE |
Edgware | 0.1.X.RELEASE | 1.5.X.RELEASE |
Dalston | 0.1.X.RELEASE | 1.5.X.RELEASE |
另外在父项目的pom.xml中,需要理解dependencyManagement与dependencies区别:
- dependencyManagement里只是声明依赖,并不实现引入,因此子项目需要显式的声明需要用的依赖。如果不在子项目中声明依赖,是不会从父项目中继承下来的;只有在子项目中写了该依赖项,并且没有指定具体版本,才会从父项目中继承该项,并且version和scope都读取自父pom;另外如果子项目中指定了版本号,那么会使用子项目中指定的jar版本
- dependencies即使在子模块中不写该依赖项,那么子模块仍然会从父项目中继承该依赖项(全部继承)
创建子项目
创建具体业务子项目,比如现在我们创建一个最常见的用户微服务项目,为了更清晰的划分具体微服务功能结构,
将业务子项目划分三个更细化的子项目,它们是:
- 提供主体业务实现的微服务mingx-user
- 提供pojo类的微服务mingx-user-pojo
- 提供微服务之间调用的微服务mingx-user-client
具体操作步骤:
- STS创建mingx-user,file->new->other…,选择Maven下的
Maven Module
,如下图: - 创建完成之后,修改pom.xml文件,如下:
<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>
<parent>
<groupId>com.mingx</groupId>
<artifactId>mingx-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<artifactId>mingx-user</artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
</dependencies>
</project>
注:此处引入的spring-cloud-starter-config理论上应该不用,但是以目前简单形式启动子项目会出现无法读取到配置文件的问题,报No active profile set, falling back to default profiles: default,导致即使在配置文件中设置了端口号,启动仍然是8080,后续结合nacos后,不需要次依赖了。
3. 在src/main/java
目录下创建com.mingx
包,创建UserApplication.java主函数文件,其中代码如下:
package com.mingx;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class UserApplication {
public static void main(String[] args) {
SpringApplication.run(UserApplication.class, args);
}
}
4.在src/main/java
目录下创建com.mingx.user.controller包,存放控制类相关文件,创建UserController.java类,用于测试,里面代码如下:
package com.mingx.user.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/user")
public class UserController {
@GetMapping("/helloUser")
public String helloUser() {
return "Hello user" ;
}
}
5.在main/src/resourse
目录下,创建项目配置文件bootstrap.yml
,内容如下:
spring:
application:
name: mingx-user # 项目名称
server:
port: 7001 # 启动端口
6.现在可以启动mingx-user项目了,找到UserApplication.java,空白处右击run as -->Springboot app
7.正常启动成功后,在浏览器中访问:http://127.0.0.1:7001/user/helloUser,如果可以正常响应如下内容,说明已经成功了。
注:
在创建了多个子项目后,如果不做什么设置在STS中显示是这样子的:
对于有强迫症的小伙伴来说,既然图中mingx-user是mingx-demo的子项目,为什么它不在其下面,而是与父项目平行的,为了解决这个尴尬,可以在STS中做如下设置:
- window--》Show View --》Project Explorer,显示其窗口
- 在Project Explorer窗口中,点击倒三角按钮,Projects Presentation--》选择Hierarchical,此时就会以父项目包含子项目的形式显示:
结束语
关于父子项目的构建,基本上已经完成了,如果你对SpringBoot很熟,也使用过Maven的话,本章基本上没有难度,尚未涉及到SpringClould微服务相关内容,按照以上步骤,分分钟搞定。
另外其他两个POJO微服务,以及内部调用微服务,在后续业务深入后再创建,过程与创建mingx-user微服务是一致的,略有差别。
下一篇介绍Nacos,一个牛叉的注册中心和配置中心。