最新公告
  • 欢迎光临数据科学与编程,我们是数据学科学兴趣交流小组立即加入我们
  • Spring/SpringBoot常用注解总结

    整个目录如下,内容有点多:

     

    因为我个人的能力和精力有限,如果有任何不对或者需要完善的地方,请帮忙指出!Guide 哥感激不尽!

    1. @SpringBootApplication

    这里先单独拎出@SpringBootApplication 注解说一下,虽然我们一般不会主动去使用它。

    Guide 哥:这个注解是 Spring Boot 项目的基石,创建 SpringBoot 项目之后会默认在主类加上。

    根据 SpringBoot 官网,这三个注解的作用分别是:

    • @EnableAutoConfiguration:启用 SpringBoot 的自动配置机制
    • @ComponentScan:扫描被@Component (@Service,@Controller)注解的 bean,注解默认会扫描该类所在的包下所有的类。
    • @Configuration:允许在 Spring 上下文中注册额外的 bean 或导入其他配置类

    2. Spring Bean 相关

    2.1. @Autowired

    自动导入对象到类中,被注入进的类同样要被 Spring 容器管理比如:Service 类注入到 Controller 类中。

    2.2. Component,@Repository,@Service, @Controller

    我们一般使用 @Autowired 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Autowired 注解自动装配的 bean 的类,可以采用以下注解实现:

    • @Component :通用的注解,可标注任意类为 Spring 组件。如果一个 Bean 不知道属于哪个层,可以使用@Component 注解标注。
    • @Repository : 对应持久层即 Dao 层,主要用于数据库相关操作。
    • @Service : 对应服务层,主要涉及一些复杂的逻辑,需要用到 Dao 层。
    • @Controller : 对应 Spring MVC 控制层,主要用户接受用户请求并调用 Service 层返回数据给前端页面。

    2.3. @RestController

    @RestController注解是@Controller和@ResponseBody的合集,表示这是个控制器 bean,并且是将函数的返回值直 接填入 HTTP 响应体中,是 REST 风格的控制器。

    Guide 哥:现在都是前后端分离,说实话我已经很久没有用过@Controller。如果你的项目太老了的话,就当我没说。

    单独使用 @Controller 不加 @ResponseBody的话一般使用在要返回一个视图的情况,这种情况属于比较传统的 Spring MVC 的应用,对应于前后端不分离的情况。@Controller +@ResponseBody 返回 JSON 或 XML 形式数据

    2.4. @Scope

     

    四种常见的 Spring Bean 的作用域:

    • singleton : 唯一 bean 实例,Spring 中的 bean 默认都是单例的。
    • prototype : 每次请求都会创建一个新的 bean 实例。
    • request : 每一次 HTTP 请求都会产生一个新的 bean,该 bean 仅在当前 HTTP request 内有效。
    • session : 每一次 HTTP 请求都会产生一个新的 bean,该 bean 仅在当前 HTTP session 内有效。

    2.5. Configuration

    一般用来声明配置类,可以使用 @Component注解替代,不过使用Configuration注解声明配置类更加语义化。

    3. 处理常见的 HTTP 请求类型

    5 种常见的请求类型:

    • GET :请求从服务器获取特定资源。举个例子:GET /users(获取所有学生)
    • POST :在服务器上创建一个新的资源。举个例子:POST /users(创建学生)
    • PUT :更新服务器上的资源(客户端提供更新后的整个资源)。举个例子:PUT /users/12(更新编号为 12 的学生)
    • DELETE :从服务器删除特定的资源。举个例子:DELETE /users/12(删除编号为 12 的学生)
    • PATCH :更新服务器上的资源(客户端提供更改的属性,可以看做作是部分更新),使用的比较少,这里就不举例子了。

    3.1. GET 请求

    3.2. POST 请求

    @PostMapping("users") 等价于@RequestMapping(value="/users",method=RequestMethod.POST)

    3.3. PUT 请求

    3.4. DELETE 请求

    3.5. PATCH 请求

    一般实际项目中,我们都是 PUT 不够用了之后才用 PATCH 请求去更新数据。

    4. 前后端传值

    掌握前后端传值的正确姿势,是你开始 CRUD 的第一步!

    4.1. @PathVariable@RequestParam

    @PathVariable用于获取路径参数,@RequestParam用于获取查询参数。

    如果我们请求的 url 是:/klasses/{123456}/teachers?type=web

    那么我们服务获取到的数据就是:klassId=123456,type=web

    4.2. @RequestBody

    用于读取 Request 请求(可能是 POST,PUT,DELETE,GET 请求)的 body 部分并且Content-Type 为 application/json 格式的数据,接收到数据之后会自动将数据绑定到 Java 对象上去。系统会使用HttpMessageConverter或者自定义的HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。

    我用一个简单的例子来给演示一下基本使用!

    这样我们的后端就可以直接把 json 格式的数据映射到我们的 UserRegisterRequest 类上。

    👉 需要注意的是:一个请求方法只可以有一个@RequestBody,但是可以有多个@RequestParam@PathVariable。如果你的方法必须要用两个 @RequestBody来接受数据的话,大概率是你的数据库设计或者系统设计出问题了!

    5. 读取配置信息

    很多时候我们需要将一些常用的配置信息比如阿里云 oss、发送短信、微信认证的相关配置信息等等放到配置文件中。

    下面我们来看一下 Spring 为我们提供了哪些方式帮助我们从配置文件中读取这些配置信息。

    我们的数据源application.yml内容如下::

    6. 参数校验

    数据的校验的重要性就不用说了,即使在前端对数据进行校验的情况下,我们还是要对传入后端的数据再进行一遍校验,避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。

    JSR(Java Specification Requests) 是一套 JavaBean 参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们 JavaBean 的属性上面,这样就可以在需要校验的时候进行校验了,非常方便!

    校验的时候我们实际用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 团队最初的数据校验框架,Hibernate Validator 4.x 是 Bean Validation 1.0(JSR 303)的参考实现,Hibernate Validator 5.x 是 Bean Validation 1.1(JSR 349)的参考实现,目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0(JSR 380)的参考实现。

    SpringBoot 项目的 spring-boot-starter-web 依赖中已经有 hibernate-validator 包,不需要引用相关依赖。如下图所示(通过 idea 插件—Maven Helper 生成):

    非 SpringBoot 项目需要自行引入相关依赖包,这里不多做讲解。

    👉 需要注意的是:所有的注解,推荐使用 JSR 注解,即javax.validation.constraints,而不是org.hibernate.validator.constraints

    6.1. 一些常用的字段验证的注解

    • @NotEmpty 被注释的字符串的不能为 null 也不能为空
    • @NotBlank 被注释的字符串非 null,并且必须包含一个非空白字符
    • @Null 被注释的元素必须为 null
    • @NotNull 被注释的元素必须不为 null
    • @AssertTrue 被注释的元素必须为 true
    • @AssertFalse 被注释的元素必须为 false
    • @Pattern(regex=,flag=)被注释的元素必须符合指定的正则表达式
    • @Email 被注释的元素必须是 Email 格式。
    • @Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
    • @Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值
    • @DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值
    • @DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值
    • @Size(max=, min=)被注释的元素的大小必须在指定的范围内
    • @Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内
    • @Past被注释的元素必须是一个过去的日期
    • @Future 被注释的元素必须是一个将来的日期
    • ……

    6.2. 验证请求体(RequestBody)

    6.3. 验证请求参数(Path Variables 和 Request Parameters)

    一定一定不要忘记在类上加上 Validated 注解了,这个参数可以告诉 Spring 去校验方法参数。

    7. 全局处理 Controller 层异常

    介绍一下我们 Spring 项目必备的全局处理 Controller 层异常。

    相关注解:

    1. @ControllerAdvice :注解定义全局异常处理类
    2. @ExceptionHandler :注解声明异常处理方法

    如何使用呢?拿我们在第 5 节参数校验这块来举例子。如果方法参数不对的话就会抛出MethodArgumentNotValidException,我们来处理这个异常。

    8. JPA 相关

    简单介绍一下上面设计到的一些注解:

    1. @CreatedDate: 表示该字段为创建时间时间字段,在这个实体被 insert 的时候,会设置值

    2. @CreatedBy :表示该字段为创建人,在这个实体被 insert 的时候,会设置值

      @LastModifiedDate@LastModifiedBy同理。

    @EnableJpaAuditing:开启 JPA 审计功能。

    8.8. 删除/修改数据

    8.9. 关联关系

    • @OneToOne 声明一对一关系
    • @OneToMany 声明一对多关系
    • @ManyToOne声明多对一关系
    • MangToMang声明多对多关系

    9. 事务 @Transactional

    我们知道 Exception 分为运行时异常 RuntimeException 和非运行时异常。在@Transactional注解中如果不配置rollbackFor属性,那么事物只会在遇到RuntimeException的时候才会回滚,加上rollbackFor=Exception.class,可以让事物在遇到非运行时异常时也回滚。

    @Transactional 注解一般用在可以作用在或者方法上。

    • 作用于类:当把@Transactional 注解放在类上时,表示所有该类的public 方法都配置相同的事务属性信息。
    • 作用于方法:当类配置了@Transactional,方法也配置了@Transactional,方法的事务会覆盖类的事务配置信息。

    10. json 数据处理

    10.1. 过滤 json 数据

    11. 测试相关


    本站上原创文章未经作者许可,不得用于商业用途,仅做学习交流使用,本站免责声明。转载请注明出处,否则保留追究法律责任的权利。《署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)》许可协议授权
    数据科学与编程 » Spring/SpringBoot常用注解总结

    发表评论

    • 52会员总数(位)
    • 310资源总数(个)
    • 29本周发布(个)
    • 1 今日发布(个)
    • 331稳定运行(天)

    提供最优质的博文资源集合

    立即阅览 了解详情