Spring Boot进阶之Web进阶 学习笔记
前言
昨天 -> 带女朋友和小表弟去了动物园,看了《全球风暴》电影。
今天 -> 学习了慕课网的Spring Boot进阶之Web进阶的视频和该项目 项目源码,看了一个基于Spring Boot的API、RESTful API项目种子(骨架)的博客。
明天 -> 准备看纯洁的微笑的博客,更深入的学习Spring Boot相关知识。
该学习笔记Demo项目地址是Spring Boot 简单实例Demo
表单验证
- 1.数据验证不仅要在前端进行验证,而且还要在后台进行验证。防君子也防小人。我们通过
@Min(value = XXX, message = "XXX")
可以具体到Mode
l类的某一个字段进行限制。value
是设置最小值,message
中的内容是如果不满足最小值的情况下,需要输出的消息。
@Entity
@Data
@NoArgsConstructor
@AllArgsConstructor
public class Girl {@Id@GeneratedValueprivate Integer id;private String name;@Min(value = 18, message = "Minor girls are prohibited from entering")private Integer age;private String cupSize;}
另外我们可以用lombok
来简化消除model
类中的setter
,getter
,constructor
方法。常用的注解:@Data
,@NoArgsConstructor
, @AllArgsConstructor
。
@Data
提供所有属性的setter
和getter
方法,此外还可以提供了equals
,hashCode
, toString()
方法。
@NoArgsConstructor
注解在类上,提供了一个无参的构造方法。
@AllArgsConstructor
注解在类上,提供了一个有参的构造方法。
pom.xml
文件配置如下。
<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId></dependency>
@Valid
注解会验证Girl
类中的age
属性是否满足我们定义的验证条件。我们可以调用bindingResult.hasErrors()
方法来判断是否验证成功,内部实现是判断存放错误信息的list集合是否为空。
private final List<ObjectError> errors = new LinkedList();
public boolean hasErrors() {return !this.errors.isEmpty();}
数据验证失败后,我们加上需要处理的业务逻辑就行了。
@PostMapping(value = "/girls")public Girl girlAdd(@Valid Girl girl, BindingResult bindingResult) {if (bindingResult.hasErrors()) {System.out.println(bindingResult.getFieldError().getDefaultMessage());return null;}return girlRepository.save(girl);}
- 3.启动应用,使用
PostMan
测试API
,控制台输出了我们验证信息。
AOP处理请求
什么是AOP?
AOP
的英文名是Aspect Oriented Programming
。AOP
是一种编程范式,与语言无关,是一种程序设计思想。AOP
面向切面编程将程序中的交叉业务逻辑(比如安全,日志,事务),封装成一个切面,然后注入到目标业务逻辑中。- 实现
AOP
的技术:- 采用动态代理的技术,利用裁取消息的方式,对该消息进行装饰,以取代原有对象行为的执行。
- 是采用静态的方式,引入特定的语法创建方面,从而使得编译器可以在编译期间织入有关方面的代码。
什么是JoinPoint?
JoinPoint
顾名思义就是连接点,是程序运行期间中的某一个阶段点,比如方法的调用,异常的抛出等。
什么是PointCut?
PointCut
是JoinPoint
的集合,它是程序中需要注入Advice
中的位置集合,指明Advice
需要在什么条件下才能被触发。
什么是Advice?
- 它是某个连接点所采用的处理逻辑,也就是向连接点注入的代码。比如:输出的日志就是一个
Advice
。
什么是Advisor?
Advisor
是PointCut
和Advice
的配置器,它包括PointCut
和Advice
,是将Advice
注入程序中PointCut
位置的代码。
模拟出网络请求中输出相关日志的功能
- 流程肯定是这样的:收到
HttpRequest
请求 -> 记录请求 -> 处理网络请求 -> 生成HttpResponse
-> 记录回复。
- 流程肯定是这样的:收到
- 我们先定义一个
HttpAspect.java
。使用@Aspect
和@Component
声明这是一个切面并在Spring.xml
注册这个切面。首先用@Pointcut("execution(* girl.controller..*.*(..))")
注解这个pointCut()
方法,代表这个方法是一个PointCut
。这个注解的意思时定义在girl.controller
包或者子包里的任何类中的任意方法的执行。- 第一个
*
:通配所有的返回类型。 - 第二个
*
: 通配girl.controller包和girl.controller子包下所有的类。 - 第三个
*
: 通配所有的方法。 - 最后一个
*
: 代表方法中所有的参数。
@Before("pointCut()")
代表调用方法前的阶段,@After("pointCut()")
代表调用方法后的阶段,@AfterReturning(returning = "object", pointcut = "pointCut()")
代表执行完方法,需要return
参数的阶段。
- 第一个
- 我们先定义一个
- 同时我们也要打印
Log
,记住要引进import org.slf4j.Logger;
这个包,别引进错了包。Log
优先级如下:DEBUG > INFO > WARN > ERROR
。HttpAspect
类代码下:
- 同时我们也要打印
@Aspect
@Component
public class HttpAspect {private static final Logger _log = LoggerFactory.getLogger(HttpAspect.class);@Pointcut("execution(* girl.controller..*.*(..))")public void pointCut() {}@Before("pointCut()")public void doBefore(JoinPoint joinPoint) {ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();HttpServletRequest request = attributes.getRequest();_log.info("url = {}", request.getRequestURL());_log.info("method = {}", request.getMethod());_log.info("ip = {}", request.getRemoteAddr());_log.info("class_method = {}", joinPoint.getSignature().getDeclaringTypeName() + "." + joinPoint.getSignature().getName());_log.info("args = {}", joinPoint.getArgs());}@After("pointCut()")public void doAfter() {_log.info("after");}@AfterReturning(returning = "object", pointcut = "pointCut()")public void doAtferReturning(Object object) {_log.info("response = {}", object);}
}
- 启动应用,我们用
PostMan
测试API
,观看Console
输出的结果。和我们预期的是一样的,输出了网络请求相关的日志。
- 启动应用,我们用
全局异常处理
- 1.定义响应结果Result类,我们可以看到聚合接口官网提供的接口,数据返回的格式是这样子的。
所以这个类有code
,msg
,data
这三个属性。
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Result {private Integer code;private String msg;private Object data;
}
- 2.接着我们需要再定义一个响应结果状态码的
ResultCode
类,为了标识每一个状态码对应着错误的信息。我们可以使用枚举的形式。
public enum ResultCode {UNKNOW_ERROR(-1, "unknow error"),SUCCESS(0, "success"),UNAUTHORIZED(401, "no authorized"),NOT_FOUND(404, "not found"),INTERNAL_SERVER_ERROR(500, "internal server error"),LOLITA(1, "lolita"),ROYAL_SISTER(2, "royal sister"),YOUNG_WOMAN(3, "young woman"),AUNT(4, "aunt");private Integer code;private String msg;ResultCode(Integer code, String msg) {this.code = code;this.msg = msg;}public Integer getCode() {return code;}public void setCode(Integer code) {this.code = code;}public String getMsg() {return msg;}public void setMsg(String msg) {this.msg = msg;}
}
- 3.接着我们在定义一个响应结果生成的工具类
ResultGenerator
,运用了静态工厂方法,提供success
,errror()
方法去创建相应的响应结果result
类,使代码变得简洁。
public class ResultGenerator {public static Result success() {return success(null);}public static Result success(Object object) {Result result = new Result();result.setCode(ResultCode.SUCCESS.getCode());result.setMsg(ResultCode.SUCCESS.getMsg());result.setData(object);return result;}public static Result error(ResultCode resultCode) {Result result = new Result();result.setCode(resultCode.getCode());result.setMsg(resultCode.getMsg());result.setData(null);return result;}
}
静态工厂的优点:
* 它们都有名称。比如ResultGenerator.success()
,很显而易见。
* 不必每次调用success()
,error()
方法时都创建一个ResultGenerator
类的实例。
* 它们可以返回原返回类型的任何子类型的对象。
* 在创建参数化类型实例的时候,它们使得代码变得更加简洁。比如类型推导。
- 我们接着定义一个
ExceptionHandler.java
。使用@ControllerAdvice
,声明这个类是可以全局处理异常的类。使用@org.springframework.web.bind.annotation.ExceptionHandler(value = Exception.class)
注解到具体的方法上去处理异常。
- 我们接着定义一个
@ControllerAdvice
public class ExceptionHandler {private static final Logger _log = LoggerFactory.getLogger(ExceptionHandler.class);@org.springframework.web.bind.annotation.ExceptionHandler(value = Exception.class)@ResponseBodypublic Result handlerException(Exception e) {if (e instanceof GirlException) {return ResultGenerator.error(((GirlException) e).getResultCode());} else {_log.error("unknow exception = {}", e.getMessage());return ResultGenerator.error(ResultCode.UNKNOW_ERROR);}}
}
- 自定义
GirlException.java
- 自定义
public class GirlException extends RuntimeException {private Integer code;private ResultCode resultCode;public GirlException(ResultCode resultCode) {super(resultCode.getMsg());this.resultCode = resultCode;this.code = resultCode.getCode();}public Integer getCode() {return code;}public ResultCode getResultCode() {return resultCode;}
}
- 在
GirlService
类中可以定义一个方法,通过传入一个女生的年龄,返回她所处于的阶段。流程: 我们通过传入id
,查询到具体的Girl
类。年龄在(0,18)
是萝莉,【18,30)
是御姐,【30,35)
是少妇,其他年龄段的统称大妈。我们返回数据的形式是通过抛出异常,异常向上抛出。
- 在
@GetMapping(value = "/girls/getAge/{id}")public void getAge(@PathVariable("id") Integer id) throws GirlException {girlService.getAge(id);}
GirlController
调用getAge()
方法,不处理GirlException
异常,继续向上抛出异常。那么ExceptionHandler
就能处理这个异常了,通过判断异常的类型,返回相应的Result
响应结果。
public void getAge(Integer id) throws GirlException {Girl girl = girlRepository.findOne(id);int age = girl.getAge();if (age > 0 && age < 18) {throw new GirlException(ResultCode.LOLITA);} else if (age >= 18 && age < 30) {throw new GirlException(ResultCode.ROYAL_SISTER);} else if (age >= 30 && age < 35) {throw new GirlException(ResultCode.YOUNG_WOMAN);} else {throw new GirlException(ResultCode.AUNT);}}
- 7 启动应用,调试
API
,http://localhost:8081/girl/girls/getAge/1
,输出结果。显而易见,id=1
对应着小妹妹的年龄为15
,15
在(0,18)
区间段,应该输出“萝莉”。
单元测试
每一个合格的程序员在写完相应的业务逻辑后,不可避免的需要去写Unit Test Case
。 Dao
层,Service
层,Controller
层要100%
覆盖到,不要遗漏任何一个方法。
- 1 把光标移动
GirlControlle
r类,使用快捷键Ctrl + Shift + T
去创建测试单元
- 我们需要选择测试的方法,最好全部勾住。
- 选择完毕后,
Intelli J
会帮我们创建好测试的类,我们只需要在类上加上相应的注解就行了。Dao
层和Service
层加上@SpringBootTest
@RunWith(SpringRunner.class)
即可。
- 选择完毕后,
@SpringBootTest
@RunWith(SpringRunner.class)
@AutoConfigureMockMvc
public class GirlControllerTest {@Autowiredprivate MockMvc mockMvc;@Testpublic void girlFindOne() throws Exception {mockMvc.perform(MockMvcRequestBuilders.get("/girls/1")).andExpect(MockMvcResultMatchers.status().isOk()).andExpect(MockMvcResultMatchers.content().string("abc"));}}
Controller
层我们还需要加上额外的@AutoConfigureMockMvc
注解,因为我们要模拟请求去测试我们的Controller类中的方法,所以需要配置MockMvc
,使用@AutoConfigureMockMvc
。
@SpringBootTest
@RunWith(SpringRunner.class)
public class GirlServiceTest {@Autowiredprivate GirlService girlService;@Testpublic void findOne() throws Exception {Girl girl = girlService.findOne(1);Assert.assertEquals(new Integer(15), girl.getAge());}}
- 我们可以去下断言
Assert
和andExpect
,比如这个请求返回的状态码是否是200
,请求返回的内容是否与我们预期的保持一致等等。然后去Ctrl +Shift + F10
跑Test Case。
- 我们可以去下断言
- 绿色代表成功,红色代表失败。因为
"/girls/1"
返回的结果 本来就不等于“abc”
,断言失败。我们去掉.andExpect(MockMvcResultMatchers.content().string("abc"))
,再去run
一下Test Case
,查看结果,很显然是成功的。
- 绿色代表成功,红色代表失败。因为
如果TestCase很多,我们需要像这样一个一个的跑吗?
很显然,答案是不需要的。我们在girl
项目的根目录打开命令窗口,输入 mvn clean package
,我们在打包的时候,会自动跑完Test Case
,输出测试结果。因为我刚才又加上了andExpect(MockMvcResultMatchers.content().string("abc"))
,会导致一个Test Case
失败。
如果我们在打包的时候,不想去跑Test Case
,因为跑Case
会影响打包的速度或者有时候跑Case
会发生一些未知的错误。那么我们只需要在打包的时候输入mvn clean package -Dmaven.test.skip=true
即可,观看结果。完美跳过Test Case
,美滋滋Build Success
。
注意事项
DemoApplication.java
是Spring Boot
的应用入口,这个类应该和其他类所在的目录应该保持同级,不然调用SpringApplication.run(DemoApplication.class, args)
方法,启动应用成功,但是dispatcherServlet
映射url`会发生错误。
- 全局处理异常的时候,需要返回
json
格式,需要加上注解@ResponseBody
,比如我就经常忘记这个注解。写@RestController
写习惯了!
尾言
从S1
末到S7
了,从高一到明年大学毕业,时光荏苒。昨天RNG
输了,今天WE
输了。可是我的青春已经如烟了。加油LPL
,百炼成钢,心之所向,风雨兼程。
Spring Boot进阶之Web进阶 学习笔记相关推荐
- 【Spring Boot JPA】ManyToOne OneToMany学习笔记
Spring Data JPA的官方文档参考:https://docs.spring.io/spring-data/jpa/docs/current/reference/html/ 我希望使用JPA进 ...
- web安全学习笔记--sql语句(sql注入基础上)
一.基础知和表内操作语法 1.sql语句对大小写不敏感!!! SELECT - 从数据库表中获取数据:select * from (columns/tables/databases); UPDATE ...
- Spring Boot WebFlux-02——WebFlux Web CRUD 实践
Spring Boot WebFlux-02--WebFlux Web CRUD 实践 第02课:WebFlux Web CRUD 实践 上一篇基于功能性端点去创建一个简单服务,实现了 Hello.这 ...
- Spring Boot + JSP 创建web项目
虽然Spring Boot的官网不推荐使用JSPs,但是本篇文章还是带你实现Spring Boot + JSP创建一个简单的web项目.想要用Spring Boot + Thymeleaf实现web项 ...
- spring boot新建非web项目(无需依赖)
spring boot新建非web项目(无需依赖) spring boot集成spring data jpa的时候需要jdk版本为1.8,所以jdk的版本最好设置为1.8 如果新建的项目是以jsp为模 ...
- 在Spring Boot中配置web app
文章目录 添加依赖 配置端口 配置Context Path 配置错误页面 在程序中停止Spring Boot 配置日志级别 注册Servlet 切换嵌套服务器 在Spring Boot中配置web a ...
- 使用Spring Boot构建REST Web服务
本教程提供了有关如何使用Spring Boot构建Restfull Web服务的分步指南. 先决条件: Eclipse IDE(最新版本) Maven的4 Java 1.8 1.创建Maven Web ...
- Spring Boot 构建RESTful Web服务
Spring Boot 构建RESTful Web服务 本指南将引导您完成使用Spring 创建" Hello World" RESTful Web服务的过程. 你会建立什么 您将 ...
- Spring Boot(二):Web 综合开发
Spring Boot(二):Web 综合开发 上篇文章介绍了 Spring Boot 初级教程:Spring Boot(一):入门篇,方便大家快速入门.了解实践 Spring Boot 特性:本篇文 ...
最新文章
- idea快捷键生成返回类型_十三肝了2晚的《IDEA操作手册-终极秘籍》终于来了......
- Git_工作区和暂存区
- 《STL源码剖析常见面试问题》
- Elasticsearch7.15.2 集成ik中文分词器 适用于单机和集群
- C语言和设计模式(状态模式)
- 极速办公(PPT)字体如何设置斜体
- FMCW毫米波雷达中CFAR研究初探(附Python代码)
- Ubuntu 切换中文目录为英文目录
- dell进入u盘启动模式_戴尔Dell笔记本电脑的BIOS怎么设置从U盘启动
- 娱乐圈有缘无份的明星
- LeetCode第714题解析
- redis中使用GeoHash
- R语言数据对象与运算
- 淘宝首页交互5--选项卡
- 美容院加盟十大品牌到底怎么选
- python locust学习笔记
- arduino知识点梳理(二)——INPUT_PULLUP模式
- 使用蓝桥杯单片机做一个智能密码锁可以修改密码
- java中构造方法的理解,super()与构造方法,无参,有参构造方法,this()与构造方法。
- 中小型企业网络解决方案的设计和实施