经过前期的需求分析和模型设计与系统架构设计,我们对项目的整体结构有了更清晰的认识,剩下的工作就是依据设计,将项目骨架拉出来,往里面直充血肉。构建起系统中的子微服务模块。
一、搭建整个项目骨架约定项目名称为 parking-project ,建立 Maven 项目,packaging 方式 为 pom,用于管理所有模块。在 parking-project 项目下依据功能模块依次建立 maven module 子项目。采用 IDE工具。以 Maven Project 形式创建父项目,用于管理子模块功能。
可以看到,子模块自动将 parent project 设置为 parking-project 父项目。由于是采用 Spring Boot 的方式构建子项目,此处选择 packaging 方式为 jar 。依此连续创建各种子模块即可,最终的结果如下:
简单介绍下各模块的功用:
- parking-base-serv,pom 项目,里面包含两个子模块:parking-admin,parking-gateway。
- parking-admin,监控子项目的运行情况。
- parking-gateway,网关子服务,配合 JWT 实现会话、验权等功用。
- parking-carwash,洗车子服务,连接 park-carwash 数据库。
- parking-card,积分子服务,连接 park-card 数据库。
- parking-charging,计费子服务,连接 parking-charging 存储库
- parking-finance,财务子服务,连接 parking-finance 存储库。
- parking-member,会员子服务,连接 park-member 存储库。
- parking-resource,资源子服务,连接 park-resource 存储库。
- parking-message,消息子服务,连接 park-message 存储库,连同 rocketmq 存储消息数据
- parking-common,存储通用的工具类,实体包等等。
每个子模块都是一个 Spring Boot 项目,如果在子模块中引入,会造成大量的重复工作,而且版本不宜统一维护,容易出现多版本的混乱局面,所以 Spring Boot 的版本需要全局统一维护。每个子项目需要构建成 jar 文件运行,子项目中已经依赖父项目的配置,每个子项目 pom.xml 文件都有这样的依赖:
com.mall.parking.root
parking-project
0.0.1-SNAPSHOT
如果按照常见的方式,再用 parent 方式引入 spring-boot-starter-parent 依赖,显然违背单个 pom 文件中只有一个 parent 标签的标准,编译就会不通过。
org.springframework.boot
spring-boot-starter-parent
2.2.2.RELEASE
为解决这个问题,此处采用 parking-project 父项目中以 depencyMangement 方式引入 spring-boot-starter-parent,子项目依赖 parent 父配置即可。
org.springframework.boot
spring-boot-dependencies
${spring.boot.version}
pom
import
有小伙伴可能会提出直接在根项目的 pom 采用 parent 的方式引入,子模块直接通过 maven 依赖就可以,这种方式在独立运行 Spring Boot 项目时没问题。后续以同样的方式引入 Spring Cloud 或 Spring Cloud Alibaba ,一个 parent 标签显然不满足这个需求,用 dependencyManagement 的方式可以规避这个问题。
2.2 引入 MBG 插件MBG 插件可以自动生成 mapper 接口、mapper xml 配置、相应实体类,主要作用在于快速开发,省去不必要的代码编写。
在 pom 中配置依赖 MBG 的插件:
parking-member-service
org.mybatis.generator
mybatis-generator-maven-plugin
1.4.0
src/test/resources/generatorConfig.xml
true
true
在 src/test/resource 目录下写入 generatorConfig.xml 文件,配置 MBG 插件 所需的基本配置项。
配置完成后,在项目名称” parking-member “ 上右键,弹出菜单中选择" Run As " —>" Maven build… ",在 Goals 栏目中输入如下命令:
mybatis-generator:generate
命令执行成功后,在对应的目录下找到相应的文件,而后 copy 到 src/java 对应的目录下,再将 test目录下生成的文件删除。
- 1.4 版本之前的,MBG 插件生成的 xml 文件,是追加模式,而不是覆盖,容易形成重复的标签。
- MBG 并不会生成 controller/service 层相关的代码,需要自己手动完成。
由于编译阶段就要使用 lombok,所以需要在 IDE 中安装 lombok 插件,才能正常编译。
2.4 日志注解如果不想每次都写,可以用注解@sl4j来打印日志。
private final Logger logger = LoggerFactory.getLogger(当前类名.class);
2.5 引入MyBatis依赖
更高效的引入MyBatis,这里采用 starter 的方式引入,同样在根pom.xml 文件中维护组件版本。
org.mybatis.spring.boot
mybatis-spring-boot-starter
mysql
mysql-connector-java
在 application.properties 配置文件中设置数据库连接,Spring Boot 2.x 版本默认采用是 HikariCP 作为 JDBC 连接池。
mybatis.type-aliases-package=com.mall.parking.member.entity
#如果需要更换 Druid 连接池,需要增加如下的配置项:
#spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
#use new driver replace deprecated driver:com.mysql.jdbc.Driver.
spring.datasource.driverClassName = com.mysql.cj.jdbc.Driver
spring.datasource.url = jdbc:mysql://localhost:3306/park_member?useUnicode=true&characterEncoding=utf-8
spring.datasource.username = root
spring.datasource.password = root
使 mapper 接口文件能够被系统扫描,在主类中通过@mapperscan注解,或直接在mapper接口文件上加@mapper注解。
2.6 测试框架是否成功@RestController
@RequestMapping("member")
@Slf4j
public class MemberController {
@Autowired
MemberService memberService;
@RequestMapping("/list")
public List list() {
List members = memberService.list();
log.debug("query member list = " + members);
return members;
}
}
MemberServiceImpl 实现类
@Service
public class MemberServiceImpl implements MemberService {
@Autowired
MemberMapper memberMapper;
@Override
public List list() {
MemberExample example = new MemberExample();
List members = memberMapper.selectByExample(example);
return members;
}
}
启动项目,成功后显示成功日志:
2019-12-30 16:45:13.496 INFO 9784 --- [ main] c.mall.parking.member.MemberApplication : Started MemberApplication in 6.52 seconds (JVM running for 7.753)
打开 Postman 插件,测试刚才的方法是否正常,操作如下:
日常产品研发中必然涉及到多部署的问题,比如开发环境、测试环境、生产环境等,这就要求代码部署能够应对多环境的要求。通过人工修改的方式,不但容易出错,也会浪费人力成本,必须结合自动化构建来提高准确性。Spring Boot 提供了基于 profile 的多环境配置,可以在各微服务项目上增加多个配置文件,如
- application.properties/yml 基础公共配置
- application-dev.properties/yml 开发环境配置
- application-test.properties/yml 测试环境配置
- application-pro.properties/yml 生产环境配置
在公共配置文件 application.properties 中,通过配置 spring.profiles.active = dev
来决定启用哪个配置,或在启动构建包时,增加命令来激活不同的环境配置: java -jar parking-member.jar --spring.profiles.active=dev
至此,第一个简单的 Spring Boot 模块搭建完成,下一步将 park-member 模块的正常业务功能编码完成即可。