乐趣区

关于spring:接近8000字的SpringSpringBoot常用注解总结安排

jiezi

@[toc]

0. 前言

大家好，我是 Guide 哥！这是我的 221 篇优质原创文章。如需转载，请在文首注明地址，蟹蟹！

本文曾经收录进我的 89K Star 的 Java 开源我的项目 JavaGuide：https://github.com/Snailclimb/JavaGuide

能够毫不夸大地说，这篇文章介绍的 Spring/SpringBoot 罕用注解根本曾经涵盖你工作中遇到的大部分罕用的场景。对于每一个注解我都说了具体用法，把握搞懂，应用 SpringBoot 来开发我的项目根本没啥大问题了！

为什么要写这篇文章？

最近看到网上有一篇对于 SpringBoot 罕用注解的文章被转载的比拟多，我看了文章内容之后属实感觉品质有点低，并且有点会误导没有太多理论应用教训的人（这些人又占据了大多数）。所以，本人索性花了大略 两天工夫简略总结一下了。

因为我集体的能力和精力有限，如果有任何不对或者须要欠缺的中央，请帮忙指出！Guide 哥感激不尽！

1. @SpringBootApplication

这里先独自拎出@SpringBootApplication 注解说一下，尽管咱们个别不会被动去应用它。

Guide 哥：这个注解是 Spring Boot 我的项目的基石，创立 SpringBoot 我的项目之后会默认在主类加上。

@SpringBootApplication
public class SpringSecurityJwtGuideApplication {public static void main(java.lang.String[] args) {SpringApplication.run(SpringSecurityJwtGuideApplication.class, args);
    }
}

咱们能够把 @SpringBootApplication看作是 @Configuration、@EnableAutoConfiguration、@ComponentScan 注解的汇合。

package org.springframework.boot.autoconfigure;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters = {@Filter(type = FilterType.CUSTOM, classes = TypeExcludeFilter.class),
        @Filter(type = FilterType.CUSTOM, classes = AutoConfigurationExcludeFilter.class) })
public @interface SpringBootApplication {......}

package org.springframework.boot;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Configuration
public @interface SpringBootConfiguration {}

依据 SpringBoot 官网，这三个注解的作用别离是：

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

2. Spring Bean 相干

2.1. @Autowired

主动导入对象到类中，被注入进的类同样要被 Spring 容器治理比方：Service 类注入到 Controller 类中。

@Service
public class UserService {......}

@RestController
@RequestMapping("/users")
public class UserController {
   @Autowired
   private UserService userService;
   ......
}

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 模式数据

对于 @RestController 和 @Controller 的比照，请看这篇文章：@RestController vs @Controller。

2.4. @Scope

申明 Spring Bean 的作用域，应用办法:

@Bean
@Scope("singleton")
public Person personSingleton() {return new Person();
}

四种常见的 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 注解申明配置类更加语义化。

@Configuration
public class AppConfig {
    @Bean
    public TransferService transferService() {return new TransferServiceImpl();
    }

}

3. 解决常见的 HTTP 申请类型

5 种常见的申请类型:

  • GET：申请从服务器获取特定资源。举个例子：GET /users（获取所有学生）
  • POST：在服务器上创立一个新的资源。举个例子：POST /users（创立学生）
  • PUT：更新服务器上的资源（客户端提供更新后的整个资源）。举个例子：PUT /users/12（更新编号为 12 的学生）
  • DELETE：从服务器删除特定的资源。举个例子：DELETE /users/12（删除编号为 12 的学生）
  • PATCH：更新服务器上的资源（客户端提供更改的属性，能够看做作是局部更新），应用的比拟少，这里就不举例子了。

3.1. GET 申请

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

@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers() {return userRepository.findAll();
}

3.2. POST 申请

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

对于 @RequestBody 注解的应用，在上面的“前后端传值”这块会讲到。

@PostMapping("/users")
public ResponseEntity<User> createUser(@Valid @RequestBody UserCreateRequest userCreateRequest) {return userRespository.save(user);
}

3.3. PUT 申请

@PutMapping("/users/{userId}") 等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)

@PutMapping("/users/{userId}")
public ResponseEntity<User> updateUser(@PathVariable(value = "userId") Long userId,
  @Valid @RequestBody UserUpdateRequest userUpdateRequest) {......}

3.4. DELETE 申请

@DeleteMapping("/users/{userId}")等价于@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)

@DeleteMapping("/users/{userId}")
public ResponseEntity deleteUser(@PathVariable(value = "userId") Long userId){......}

3.5. PATCH 申请

个别理论我的项目中，咱们都是 PUT 不够用了之后才用 PATCH 申请去更新数据。

  @PatchMapping("/profile")
  public ResponseEntity updateStudent(@RequestBody StudentUpdateRequest studentUpdateRequest) {studentRepository.updateDetail(studentUpdateRequest);
        return ResponseEntity.ok().build();
    }

4. 前后端传值

把握前后端传值的正确姿态，是你开始 CRUD 的第一步！

4.1. @PathVariable 和 @RequestParam

@PathVariable用于获取门路参数，@RequestParam用于获取查问参数。

举个简略的例子：

@GetMapping("/klasses/{klassId}/teachers")
public List<Teacher> getKlassRelatedTeachers(@PathVariable("klassId") Long klassId,
         @RequestParam(value = "type", required = false) String type ) {...}

如果咱们申请的 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 对象。

我用一个简略的例子来给演示一下根本应用！

咱们有一个注册的接口：

@PostMapping("/sign-up")
public ResponseEntity signUp(@RequestBody @Valid UserRegisterRequest userRegisterRequest) {userService.save(userRegisterRequest);
  return ResponseEntity.ok().build();
}

UserRegisterRequest对象：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserRegisterRequest {
    @NotBlank
    private String userName;
    @NotBlank
    private String password;
    @FullName
    @NotBlank
    private String fullName;
}

咱们发送 post 申请到这个接口，并且 body 携带 JSON 数据：

{"userName":"coder","fullName":"shuangkou","password":"123456"}

这样咱们的后端就能够间接把 json 格局的数据映射到咱们的 UserRegisterRequest 类上。

???? 须要留神的是：一个申请办法只能够有一个 @RequestBody，然而能够有多个@RequestParam 和@PathVariable。如果你的办法必须要用两个 @RequestBody来承受数据的话，大概率是你的数据库设计或者零碎设计出问题了！

5. 读取配置信息

很多时候咱们须要将一些罕用的配置信息比方阿里云 oss、发送短信、微信认证的相干配置信息等等放到配置文件中。

上面咱们来看一下 Spring 为咱们提供了哪些形式帮忙咱们从配置文件中读取这些配置信息。

咱们的数据源 application.yml 内容如下：：

wuhan2020: 2020 年初武汉暴发了新型冠状病毒，疫情重大，然而，我置信所有都会过来！武汉加油！中国加油！my-profile:
  name: Guide 哥
  email: koushuangbwcx@163.com

library:
  location: 湖北武汉加油中国加油
  books:
    - name: 蠢才基本法
      description: 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天，得悉本人暗恋多年的校园男神裴之行将出国深造的音讯——对方考取的学校，恰是父亲当年为她放弃的那所。- name: 工夫的秩序
      description: 为什么咱们记得过来，而非将来？工夫“流逝”意味着什么？是咱们存在于工夫之内，还是工夫存在于咱们之中？卡洛·罗韦利用诗意的文字，邀请咱们思考这一亘古难题——工夫的实质。- name: 了不起的我
      description: 如何养成一个新习惯？如何让心智变得更成熟？如何领有高质量的关系？如何走出人生的艰巨时刻？

5.1. @value(罕用)

应用 @Value("${property}") 读取比较简单的配置信息：

@Value("${wuhan2020}")
String wuhan2020;

5.2. @ConfigurationProperties(罕用)

通过 @ConfigurationProperties 读取配置信息并与 bean 绑定。

@Component
@ConfigurationProperties(prefix = "library")
class LibraryProperties {
    @NotEmpty
    private String location;
    private List<Book> books;

    @Setter
    @Getter
    @ToString
    static class Book {
        String name;
        String description;
    }
  省略 getter/setter
  ......
}

你能够像应用一般的 Spring bean 一样，将其注入到类中应用。

5.3. PropertySource（不罕用）

@PropertySource读取指定 properties 文件

@Component
@PropertySource("classpath:website.properties")

class WebSite {@Value("${url}")
    private String url;

  省略 getter/setter
  ......
}

更多内容请查看我的这篇文章：《10 分钟搞定 SpringBoot 如何优雅读取配置文件？》。

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 我的项目须要自行引入相干依赖包，这里不多做解说，具体能够查看我的这篇文章：《如何在 Spring/Spring Boot 中做参数校验？你须要理解的都在这里！》。

???? 须要留神的是：所有的注解，举荐应用 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)

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {@NotNull(message = "classId 不能为空")
    private String classId;

    @Size(max = 33)
    @NotNull(message = "name 不能为空")
    private String name;

    @Pattern(regexp = "((^Man$|^Woman$|^UGM$))", message = "sex 值不在可选范畴")
    @NotNull(message = "sex 不能为空")
    private String sex;

    @Email(message = "email 格局不正确")
    @NotNull(message = "email 不能为空")
    private String email;

}

咱们在须要验证的参数上加上了 @Valid 注解，如果验证失败，它将抛出MethodArgumentNotValidException。

@RestController
@RequestMapping("/api")
public class PersonController {@PostMapping("/person")
    public ResponseEntity<Person> getPerson(@RequestBody @Valid Person person) {return ResponseEntity.ok().body(person);
    }
}

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

肯定肯定不要遗记在类上加上 Validated 注解了，这个参数能够通知 Spring 去校验办法参数。

@RestController
@RequestMapping("/api")
@Validated
public class PersonController {@GetMapping("/person/{id}")
    public ResponseEntity<Integer> getPersonByID(@Valid @PathVariable("id") @Max(value = 5,message = "超过 id 的范畴了") Integer id) {return ResponseEntity.ok().body(id);
    }
}

更多对于如何在 Spring 我的项目中进行参数校验的内容，请看《如何在 Spring/Spring Boot 中做参数校验？你须要理解的都在这里！》这篇文章。

7. 全局解决 Controller 层异样

介绍一下咱们 Spring 我的项目必备的全局解决 Controller 层异样。

相干注解：

  1. @ControllerAdvice : 注解定义全局异样解决类
  2. @ExceptionHandler : 注解申明异样解决办法

如何应用呢？拿咱们在第 5 节参数校验这块来举例子。如果办法参数不对的话就会抛出MethodArgumentNotValidException，咱们来解决这个异样。

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {

    /**
     * 申请参数异样解决
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {......}
}

更多对于 Spring Boot 异样解决的内容，请看我的这两篇文章：

  1. SpringBoot 解决异样的几种常见姿态
  2. 应用枚举简略封装一个优雅的 Spring Boot 全局异样解决！

8. JPA 相干

8.1. 创立表

@Entity申明一个类对应一个数据库实体。

@Table 设置表明

@Entity
@Table(name = "role")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String description;
    省略 getter/setter......
}

8.2. 创立主键

@Id：申明一个字段为主键。

应用 @Id 申明之后，咱们还须要定义主键的生成策略。咱们能够应用 @GeneratedValue 指定主键生成策略。

1. 通过 @GeneratedValue间接应用 JPA 内置提供的四种主键生成策略来指定主键生成策略。

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

JPA 应用枚举定义了 4 中常见的主键生成策略，如下：

Guide 哥：枚举代替常量的一种用法

public enum GenerationType {

    /**
     * 应用一个特定的数据库表格来保留主键
     * 长久化引擎通过关系数据库的一张特定的表格来生成主键,
     */
    TABLE,

    /**
     * 在某些数据库中, 不反对主键自增长, 比方 Oracle、PostgreSQL 其提供了一种叫做 "序列(sequence)" 的机制生成主键
     */
    SEQUENCE,

    /**
     * 主键自增长
     */
    IDENTITY,

    /**
     * 把主键生成策略交给长久化引擎(persistence engine),
     * 长久化引擎会依据数据库在以上三种主键生成 策略中抉择其中一种
     */
    AUTO
}

@GeneratedValue注解默认应用的策略是GenerationType.AUTO

public @interface GeneratedValue {GenerationType strategy() default AUTO;
    String generator() default "";}

个别应用 MySQL 数据库的话，应用 GenerationType.IDENTITY 策略比拟广泛一点（分布式系统的话须要另外思考应用分布式 ID）。

2. 通过 @GenericGenerator申明一个主键策略，而后 @GeneratedValue应用这个策略

@Id
@GeneratedValue(generator = "IdentityIdGenerator")
@GenericGenerator(name = "IdentityIdGenerator", strategy = "identity")
private Long id;

等价于：

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

jpa 提供的主键生成策略有如下几种：

public class DefaultIdentifierGeneratorFactory
        implements MutableIdentifierGeneratorFactory, Serializable, ServiceRegistryAwareService {@SuppressWarnings("deprecation")
    public DefaultIdentifierGeneratorFactory() {register( "uuid2", UUIDGenerator.class);
        register("guid", GUIDGenerator.class);            // can be done with UUIDGenerator + strategy
        register("uuid", UUIDHexGenerator.class);            // "deprecated" for new use
        register("uuid.hex", UUIDHexGenerator.class);     // uuid.hex is deprecated
        register("assigned", Assigned.class);
        register("identity", IdentityGenerator.class);
        register("select", SelectGenerator.class);
        register("sequence", SequenceStyleGenerator.class);
        register("seqhilo", SequenceHiLoGenerator.class);
        register("increment", IncrementGenerator.class);
        register("foreign", ForeignGenerator.class);
        register("sequence-identity", SequenceIdentityGenerator.class);
        register("enhanced-sequence", SequenceStyleGenerator.class);
        register("enhanced-table", TableGenerator.class);
    }

    public void register(String strategy, Class generatorClass) {LOG.debugf( "Registering IdentifierGenerator strategy [%s] -> [%s]", strategy, generatorClass.getName());
        final Class previous = generatorStrategyToClassNameMap.put(strategy, generatorClass);
        if (previous != null) {LOG.debugf( "- overriding [%s]", previous.getName());
        }
    }

}

8.3. 设置字段类型

@Column 申明字段。

示例：

设置属性 userName 对应的数据库字段名为 user_name，长度为 32，非空

@Column(name = "user_name", nullable = false, length=32)
private String userName;

设置字段类型并且加默认值，这个还是挺罕用的。

Column(columnDefinition = "tinyint(1) default 1")
private Boolean enabled;

8.4. 指定不长久化特定字段

@Transient：申明不须要与数据库映射的字段，在保留的时候不须要保留进数据库。

如果咱们想让 secrect 这个字段不被长久化，能够应用 @Transient 关键字申明。

Entity(name="USER")
public class User {

    ......
    @Transient
    private String secrect; // not persistent because of @Transient

}

除了 @Transient关键字申明，还能够采纳上面几种办法：

static String secrect; // not persistent because of static
final String secrect =“Satish”; // not persistent because of final
transient String secrect; // not persistent because of transient

个别应用注解的形式比拟多。

8.5. 申明大字段

@Lob: 申明某个字段为大字段。

@Lob
private String content;

更具体的申明：

@Lob
// 指定 Lob 类型数据的获取策略，FetchType.EAGER 示意非提早 加载，而 FetchType. LAZY 示意提早加载；@Basic(fetch = FetchType.EAGER)
//columnDefinition 属性指定数据表对应的 Lob 字段类型
@Column(name = "content", columnDefinition = "LONGTEXT NOT NULL")
private String content;

8.6. 创立枚举类型的字段

能够应用枚举类型的字段，不过枚举字段要用 @Enumerated 注解润饰。

public enum Gender {MALE("男性"),
    FEMALE("女性");

    private String value;
    Gender(String str){value=str;}
}
@Entity
@Table(name = "role")
public class Role {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    private String name;
    private String description;
    @Enumerated(EnumType.STRING)
    private Gender gender;
    省略 getter/setter......
}

数据库外面对应存储的是 MAIL/FEMAIL。

8.7. 减少审计性能

只有继承了 AbstractAuditBase的类都会默认加上上面四个字段。

@Data
@AllArgsConstructor
@NoArgsConstructor
@MappedSuperclass
@EntityListeners(value = AuditingEntityListener.class)
public abstract class AbstractAuditBase {

    @CreatedDate
    @Column(updatable = false)
    @JsonIgnore
    private Instant createdAt;

    @LastModifiedDate
    @JsonIgnore
    private Instant updatedAt;

    @CreatedBy
    @Column(updatable = false)
    @JsonIgnore
    private String createdBy;

    @LastModifiedBy
    @JsonIgnore
    private String updatedBy;
}

咱们对应的审计性能对应地配置类可能是上面这样的（Spring Security 我的项目）:


@Configuration
@EnableJpaAuditing
public class AuditSecurityConfiguration {
    @Bean
    AuditorAware<String> auditorAware() {return () -> Optional.ofNullable(SecurityContextHolder.getContext())
                .map(SecurityContext::getAuthentication)
                .filter(Authentication::isAuthenticated)
                .map(Authentication::getName);
    }
}

简略介绍一下下面设计到的一些注解：

  1. @CreatedDate: 示意该字段为创立工夫工夫字段，在这个实体被 insert 的时候，会设置值
  2. @CreatedBy : 示意该字段为创建人，在这个实体被 insert 的时候，会设置值

    @LastModifiedDate、@LastModifiedBy同理。

@EnableJpaAuditing：开启 JPA 审计性能。

8.8. 删除 / 批改数据

@Modifying 注解提醒 JPA 该操作是批改操作, 留神还要配合 @Transactional 注解应用。

@Repository
public interface UserRepository extends JpaRepository<User, Integer> {

    @Modifying
    @Transactional(rollbackFor = Exception.class)
    void deleteByUserName(String userName);
}

8.9. 关联关系

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

更多对于 Spring Boot JPA 的文章请看我的这篇文章：一文搞懂如何在 Spring Boot 正确中应用 JPA。

9. 事务 @Transactional

在要开启事务的办法上应用 @Transactional 注解即可!

@Transactional(rollbackFor = Exception.class)
public void save() {......}

咱们晓得 Exception 分为运行时异样 RuntimeException 和非运行时异样。在 @Transactional 注解中如果不配置 rollbackFor 属性, 那么事物只会在遇到 RuntimeException 的时候才会回滚, 加上rollbackFor=Exception.class, 能够让事物在遇到非运行时异样时也回滚。

@Transactional 注解个别用在能够作用在 类或者 办法 上。

  • 作用于类：当把@Transactional 注解放在类上时，示意所有该类的public 办法都配置雷同的事务属性信息。
  • 作用于办法：当类配置了@Transactional，办法也配置了@Transactional，办法的事务会笼罩类的事务配置信息。

更多对于对于 Spring 事务的内容请查看：

  1. 可能是最丑陋的 Spring 事务管理详解
  2. 一口气说出 6 种 @Transactional 注解生效场景

10. json 数据处理

10.1. 过滤 json 数据

@JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。

// 生成 json 时将 userRoles 属性过滤
@JsonIgnoreProperties({"userRoles"})
public class User {

    private String userName;
    private String fullName;
    private String password;
    @JsonIgnore
    private List<UserRole> userRoles = new ArrayList<>();}

@JsonIgnore个别用于类的属性上，作用和下面的@JsonIgnoreProperties 一样。


public class User {

    private String userName;
    private String fullName;
    private String password;
   // 生成 json 时将 userRoles 属性过滤
    @JsonIgnore
    private List<UserRole> userRoles = new ArrayList<>();}

10.2. 格式化 json 数据

@JsonFormat个别用来格式化 json 数据。：

比方：

@JsonFormat(shape=JsonFormat.Shape.STRING, pattern="yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", timezone="GMT")
private Date date;

10.3. 扁平化对象

@Getter
@Setter
@ToString
public class Account {
    @JsonUnwrapped
    private Location location;
    @JsonUnwrapped
    private PersonInfo personInfo;

  @Getter
  @Setter
  @ToString
  public static class Location {
     private String provinceName;
     private String countyName;
  }
  @Getter
  @Setter
  @ToString
  public static class PersonInfo {
    private String userName;
    private String fullName;
  }
}

未扁平化之前：

{
    "location": {
        "provinceName":"湖北",
        "countyName":"武汉"
    },
    "personInfo": {
        "userName": "coder1234",
        "fullName": "shaungkou"
    }
}

应用@JsonUnwrapped 扁平对象之后：

@Getter
@Setter
@ToString
public class Account {
    @JsonUnwrapped
    private Location location;
    @JsonUnwrapped
    private PersonInfo personInfo;
    ......
}
{
  "provinceName":"湖北",
  "countyName":"武汉",
  "userName": "coder1234",
  "fullName": "shaungkou"
}

11. 测试相干

@ActiveProfiles个别作用于测试类上，用于申明失效的 Spring 配置文件。

@SpringBootTest(webEnvironment = RANDOM_PORT)
@ActiveProfiles("test")
@Slf4j
public abstract class TestBase {......}

@Test申明一个办法为测试方法

@Transactional被申明的测试方法的数据会回滚，防止净化测试数据。

@WithMockUser Spring Security 提供的，用来模仿一个实在用户，并且能够赋予权限。

    @Test
    @Transactional
    @WithMockUser(username = "user-id-18163138155", authorities = "ROLE_TEACHER")
    void should_import_student_success() throws Exception {......}

临时总结到这里吧！尽管花了挺长时间才写完，不过可能还是会一些罕用的注解的被漏掉，所以，我将文章也同步到了 Github 下来，Github 地址：https://github.com/Snailclimb/JavaGuide/blob/master/docs/system-design/framework/spring/spring-annotations.md 欢送欠缺！

本文曾经收录进我的 89K Star 的 Java 开源我的项目 JavaGuide：https://github.com/Snailclimb/JavaGuide。

退出移动版