1 Spring Boot 综合应用分析
1.1 业务需求分析及设计
从数据库查询所有活动(Activity)信息,然后呈现在页面上(基于thymeleaf,标签应用参考官网thymeleaf.org)。并可以基于其活动信息进行关操作。对于软件开发人员在需求分析时通常会有这样的过程:
第一:需求调研 (与软件使用人之间的一个沟通,了解其业务)
第二:需求分析 (对需求调研内容的总结和细化)
第三:原型设计 (是对需求分析结果的更好呈现)
第四:需求评审 (签字确认,确认边界,确定业务模块)
简历:参与了需求调研,需求分析,原型设计,需求评审。
职位:需求分析师(咨询师)。
1.2 系统架构分析及设计
如何理解架构设计?(所有的架构设计必须以业务为前提,脱离业务谈架构就是耍流氓)
第一:架构模式?(CS/BS)
第二:单体架构,分布式架构,微服务架构?
第三:部署架构?(web服务器一台,数据库服务器一台,…)
第四:系统整体分层架构?(基础设施,操作系统,中间件,应用软件,接入层)
第五:软件应用的分层架构?(表示层,请求响应控制逻辑层,业务处理逻辑层,数据操作逻辑层,数据库)
职位:架构师(国内大部分架构还是要带头写代码-核心代码)
1.3 业务代码分析及设计
第一步骤:原型设计(省略)
第二步骤:数据库及表设计并初始化。(基于source指令去实现 )
第三步骤:应用架构设计(MVC)
第四步骤:业务设计,API设计,时序设计?
第五步骤:POJO对象,数据层对象,业务层对象,控制层对象,表示层。
2 SpringBoot 综合实践实现
2.1 搭建项目初始环境
第一步:初始化数据库数据(命令行执行)
打开mysql控制台,然后按如下步骤执行acitivty.sql文件:
1)登录mysql
mysql -uroot -proot
2)设置客户端编码
set names utf8
3)执行activity.sql文件
source d:/activity.sql
第二步: 创建SpringBoot maven项目
第三步:添加项目依赖(MySql,Jdbc API,MyBatis,Spring Web,Thymeleaf)
第四步:修改application.properties文件,进行资源配置
1)添加数据源配置(使用内置的HikariCP连接池)
2)添加mybatis配置
3)添加thymeleaf配置
4)添加日志配置
代码如下:
#spring datasource
spring.datasource.url=jdbc:mysql:///dbactivity?serverTimezone=GMT%2B8&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
#spring mybatis
mybatis.mapper-locations=classpath:/mapper/*/*.xml
#spring web
spring.thymeleaf.prefix=classpath:/templates/pages/
#Spring log
logging.level.com.cy=debug
第五步:启动项目,检测是否启动OK
2.2 活动模块API设计
活动模块的API对象类型及业务关系设计,如图所示:
2.3 活动模块查询业务实现
2.3.1 业务时序分析
2.3.2 服务端实现
第一步:定义pojo对象(com.cy.pj.activity.pojo.Activity)
第二步:定义ActivityDao接口及方法
第三步:定义ActivityService接口及实现类
第四步:定义ActivityController对象及url映射
2.3.3 客户端实现
第一步:定义activity.html页面
第二步:通过Thymeleaf模板引擎将活动数据呈现在页面上。
2.4 活动模块添加业务实现
2.4.1 服务端实现
第一步:在ActivityDao中定义insertActivity(Activity entity)方法以及SQL映射
第二步:在ActivityService接口及实现类中添加saveActivity(Activity entity)
第三步:在ActivityController对象中添加doSaveActivity方法并定义url映射
2.4.2 客户端实现
第一步:在页面中activity-add.html页面中引入两个js(jquery,bootstrap)
第二步:在页面中添加form表单(用户填写用户数据)
第四步:在activity-add.html页面上添加添加按钮。
第五步:在表单中输入数据, 然后点击保存按钮,将数据传递到服务端。
2.5 活动模块修改表单数据的呈现
2.5.1 服务端实现
第一步:在ActivityDao中定义findById方法,基于活动id查询活动信息
第二步:在ActivityService及实现类中添加findById方法,基于活动id查询活动信息。
第三步:在ActivityController中定义doFindById方法,基于id获取活动信息将其存储在作用域对象中,并定义url映射。
2.5.2 客户端实现
第一步:activity.html中修改按钮事件注册并定义事件处理函数
第二步:在修改按钮事件处理函数中向服务端发起请求基于id获取活动信息。
第三步:在activity-edit.html页面中获取基于id查询到的活动信息
第四步:将要修改的记录信息呈现在表单中并进行呈现。
2.6 活动模块修改操作中表单数据的提交。
2.6.1 服务端实现
第一步:ActivityDao中定义基于id更新活动信息的方法 updateObject(Activity entity)
第二步:修改ActivityServiceImpl类中saveObject方法,基于的值进行添加或修改操作
2.7 活动模块删除操作实现
2.7.1 服务端实现
第一步:ActivityDao中定义基于id删除记录的方法 deleteById(Integer id);
第二步:ActivityService及实现类中定义deleteById(Integer id)方法用于执行记录删除
第三步:ActivityController中定义doDeleteById(Integer id)方法用于处理删除请求
2.7.2 客户端实现
第一步:Activity.html中删除按钮事件注册以及事件处理函数定义
第二步:在删除事件处理函数内部向服务端发请求执行删除操作。
3 Spring Boot 应用加强实现
3.1 健康检查配置及测试
在SpringBoot中提供了一个Actuator模块,基于此模块可以实现对象项目的健康检查和监控功能,假如需要使用此模块功能,可以:
在项目中添加actuator依赖:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
健康检查分析(要重启项目):
在浏览器中输入如下地址:(SpringBoot默认打开的监控选项有限)
http://localhost/actuator
还可以在actuator列出的选中中进行点击或在浏览器直接输入访问如下地址:
http://localhost/actuator/health
假如希望查看更多actuator选项,可以在spring boot中配置文件
application.properties中添加如下语句:(生产环境不加)
management.endpoints.web.exposure.include=*
此时在浏览器地址栏可以输入.http://localhost/actuator/beans 查看所有的
spring 容器中的bean信息。
说明:还可以直接在sts工具的Boot Dashboard中选中项目(项目必须已启动),查看其属性(show properties),这种方式重点掌握。
3.2 热部署配置及实现
基于SpringBoot的Web项目,修改了某个类以后,默认不会自动重新部署和加载,需要我们手动重启服务器。假如我们希望项目可以自动部署,可以添加如下依赖,进行热部署实现。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
</dependency>
说明:当我们修改了src/main/java目录下的java文件或修改了src/main/resources目录下的配置文件时,默认都会重启你的web服务器,但是修改了测试类或html文件不会自动重启和部署。
3.3 Lombok插件应用
Lombok是一个第三库,可以基于lombok中提供的API,在程序编译时自动织入一些方法。这样做的话可以简化我们对某些方法的编写,例如,省略pojo类中的set方法,get方法,toString等方法的编写。我们写的java程序可以在编译时,通过lombok自动将这些方法添加到.class文件中,其应用步骤如下:
第一步:添加依赖。
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
第二步:找到下载的lombok-xxx.jar依赖所在的位置。
第三步:启动操作系统命令行客户端,并切换到lombok-xxx.jar文件所在的目录,然后,利用java –jar 指令启动lombok插件,如图-15所示:
图-15
回车执行如上命令,会弹出选择安装对话框,如图-16所示:
图-16
然后在弹出的框中选择sts启动执行文件(SpringToolSuite4.exe)进行安装,
安装成功以后会出现如下弹出框,如图-17所示:
图-17
安装成功以后可在STS工具的根目录看到一个lombok.jar文件,同时会在SpringToolSuite4.ini文件的尾部添加lombok.jar文件所在的具体路径,例如
-javaagent:E:\software\sts-4.5.3.RELEASE\lombok.jar。
其中lombok.jar会默认创建在sts软件的根目录,如图-18所示:
图-18
说明:安装成功以后重启sts工具.(假如安装成功以后再次启动sts,此时无法启动,可能与STS所在目录有关系,可以将安装目录下的lombok.jar文件拷出到特定目录,然后修改SpringToolSuite4.ini文件的最后一行的lombok.jar路径即可,同时在配置文件中也不能有空格)。
Lombok 常用注解分析:
▪@Setter 用于为描述的类生成setter方法,不包含final修饰属性。
▪@Getter 用于为描述的类生成getter方法。
▪@ToString 用于为描述的类添加toString方法。
▪@EqualsAndHashCode 用于为描述的类,生成hashCode和equals方法。
▪@NoArgsConstructor 用于为描述的类生成无参的构造方法。
▪@AllArgsConstructor 用于为描述的类生成包含类中所有字段的构造方法。
▪@Data用于为描述的类生成setter/getter、equals、canEqual、hashCode、toString方法,如为final属性,则不会为该属性生成setter方法。
▪@Slf4J 用于为描述的类添加一个日志属性对象
private static final Logger log =LoggerFactory.getLogger(Xxx.class);
代码案例分析:
package com.cy.pj.activity.pojo;
@Data
public class Activity {//.class
private Long id;
private String title;
private String category;
@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")
private LocalDateTime startTime;
@DateTimeFormat(pattern = "yyyy/MM/dd HH:mm:ss")
private LocalDateTime endTime;
private Short state=1;//1 有效状态
private String remark;
private String createdUser;
private LocalDateTime createdTime;
}
测试代码如下
package com.cy.pj.pojo;
import lombok.extern.slf4j.Slf4j;
@Slf4j
@SpringBootTest
public class ActivityTests {
@Test
public void testAty01() {
Activity aty=new Activity();
aty.setId(10L);
aty.setTitle("A-Title");
aty.setCategory("A-Type");
System.out.println(aty.getId());
System.out.println(aty.getTitle());
System.out.println(aty.getCategory());
log.info(aty.toString());
}
}
4 总结(Summary)
4.1 重难点分析
▪项目需求分析的基本过程(调研,分析,原型,评审)。
▪架构设计的基本过程(架构模式,架构类型,部署形式)。
▪代码实现的基本过程 (pojo,dao,service,controller)。
4.2 FAQ分析
▪SpringBoot项目启动时哪些自动配置生效了,如何查看?(配置文件中定义debug=true)
▪SpringBoot项目默认支持热部署吗,什么时候使用热部署?(需要依赖)
▪SpringBoot项目中的热部署,会在哪些资源修改以后自动重启tomcat?
▪SpringBoot项目中的健康检查(监控),可以检查哪些资源?
▪SpringBoot项目lombok插件安装以后,注解为什么不生效?
▪Thymeleaf模板引擎常用标签有哪些?(th:each,th:text,th:value,th:href,…)
▪SpringBoot项目实现过程中遇到过什么问题?(404,400,500,NPE,依赖注入,绑定异常,.)
4.3 BUG分析
▪URL请求资源不存在,如图-1所示:
图-1
其解决方案:
1)检查tomcat启动是否OK。
2)检查url对应的服务端资源是否匹配(客户端url与controller定义url)。
3)检查controller的包结构(所在包应在主启动类所在包的同包或子包中)。
4)检查application.properties中thymleaf的配置是否正确(例如前缀路径,…)。
▪视图解析失败,如图-2所示
图-2
其解决方案:
1)视图解析器的配置有问题(检查视图解析器前缀,后缀的配置。)
2)检查响应资源是否存在?
3)响应资源存在,但页面标签写的不正确。