首页 > Springboot全套注解解析《看不懂算我输》
头像
码出宇宙
编辑于 08-23 16:48 上海
+ 关注

Springboot全套注解解析《看不懂算我输》

前言

欢迎和小码哥聊一聊:扣扣群917138995,可帮查内推进度 & 聊八卦,最新秋招信息。

1. @SpringBootApplication

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


这个注解是 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 {
根据 SpringBoot 官网,这三个注解的作用分别是:


@EnableAutoConfiguration:启用 SpringBoot 的自动配置机制


@ComponentScan:扫描被@Component (@Service,@Controller)注解的 bean,注解默认会扫描该类所在的包下所有的类。


@Configuration:允许在 Spring 上下文中注册额外的 bean 或导入其他配置类

2. Spring Bean相关

2.1. @Autowired、@Resource

@Autowired

@Autowired注解是按类型装配依赖对象,默认情况下它要求依赖对象必须存在,如果允许null值,可以设置它required属性为false(默认:true)。

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

示例

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


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

注意事项:

在使用@Autowired时,首先在容器中查询对应类型的bean

如果查询结果刚好为一个,就将该bean装配给@Autowired指定的数据

如果查询的结果不止一个,那么@Autowired会根据名称来查找。

如果查询的结果为空,那么会抛出异常。解决方法时,使用required=false


@Resource

@Resource注解和@Autowired一样,也可以标注在字段或属性的setter方法上,
但它默认按名称装配。名称可以通过@Resource的name属性指定,
如果没有指定name属性,当注解标注在字段上,即默认取字段的名称作为bean名称寻找依赖对象,当注解标注在属性的setter方法上,即默认取属性名作为bean名称寻找依赖对象。

示例

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


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

@Resource装配顺序


如果同时指定了name和type,则从Spring上下文中找到唯一匹配的bean进行装配,找不到则抛出异常

如果指定了name,则从上下文中查找名称(id)匹配的bean进行装配,找不到则抛出异常

如果指定了type,则从上下文中找到类型匹配的唯一bean进行装配,找不到或者找到多个,都会抛出异常

如果既没有指定name,又没有指定type,则自动按照byName方式进行装配;如果没有匹配,则回退为一个原始类型进行匹配,如果匹配则自动装配;

区别

@Resources按名字,是JDK的,@Autowired按类型,是Spring的。

@Autowired 根据类型注入,

@Resource 默认根据名字注入,其次按照类型搜索

@Autowired @Qualifie("userService") 两个结合起来可以根据名字和类型注入

@Autowired是根据类型进行自动装配的。如果当Spring上下文中存在不止一个UserService类型的bean时,就会抛出BeanCreationException异常;如果Spring上下文中不存在UserService类型的bean,也会抛出BeanCreationException异常。
我们可以使用@Qualifier配合@Autowired来解决这些问题。如下:

示例


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


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

如果当Spring上下文中存在不止一个UserService类型的bean时@Resources

示例

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


@RestController
@RequestMapping("/users")
public class UserController {
   @Resource (name= "userService" )
   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 风格的控制器。

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

示例

@CrossOrigin
@RestController
public class SysAppManageController {

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();
    }


}

2.6. @Bean

Spring的@Bean注解用于告诉方法,产生一个Bean对象,然后这个Bean对象交给Spring管理。
产生这个Bean对象的方法Spring只会调用一次,随后这个Spring将会将这个Bean对象放在自己的IOC容器中。

SpringIOC 容器管理一个或者多个bean,这些bean都需要在@Configuration注解下进行创建,在一个方法上使用@Bean注解就表明这个方法需要交给Spring进行管理。

@Configuration public class AppConfig {


    // 使用@Bean 注解表明myBean需要交给Spring进行管理
    // 未指定bean 的名称,默认采用的是 "方法名" + "首字母小写"的配置方式
    @Bean
    public MyBean myBean(){
        return new MyBean();
    }
}

2.7. @ComponentScan

这是 Spring 3.1 添加的一个注解,用来代替配置文件中的 component-scan 配置,开启组件扫描,即自动扫描包路径下的 @Component 注解进行注册 bean 实例到 context 中


2.8. @EnableAutoConfiguration

允许 Spring Boot 自动配置注解,开启这个注解之后,Spring Boot 就能根据当前类路径下的包或者类来配置 Spring Bean。

如:当前类路径下有 Mybatis 这个 JAR 包,MybatisAutoConfiguration 注解就能根据相关参数来配置 Mybatis 的各个 Spring Bean。


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)


//value={} 可添加多个地址 多个地址都指向这一个方法
@GetMapping(value = {"/users", "/apis/users"})
public List getAllUsers() {
 return userRepository.findAll();
}

3.2. Post请求

@PostMapping("users")   功能相同
@RequestMapping(value="/users",method=RequestMethod.POST)


//value={} 可添加多个地址 多个地址都指向这一个方法
@PostMapping("/users")
public List createUser(@RequestBody UserCreateRequest userCreateRequest) {
 return userRespository.save(user);
}

3.3. Put请求

@PutMapping("/users/{userId}") 功能相同
@RequestMapping(value="/users/{userId}",method=RequestMethod.PUT)


//value={} 可添加多个地址 多个地址都指向这一个方法
@PutMapping("/users/{userId}")
public List updateUser(@PathVariable(value = "userId") Long userId,@RequestBody Map map) {
  ......
}

3.4. Delete请求

@DeleteMapping("/users/{userId}")功能相同
@RequestMapping(value="/users/{userId}",method=RequestMethod.DELETE)


//value={} 可添加多个地址 多个地址都指向这一个方法
@DeleteMapping("/users/{userId}")
public boolean deleteUser(@PathVariable(value = "userId") Long userId){
  ......
}

3.5. Patch请求

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

Patch方式是对put方式的一种补充;

put方式是可以更新.但是更新的是整体.patch是对局部更新;
@PatchMapping("/profile")
public ResponseEntity updateStudent(@RequestBody StudentUpdateRequest studentUpdateRequest) {
        studentRepository.updateDetail(studentUpdateRequest);
        return ResponseEntity.ok().build();
}

4. 前后端传值

4.1. @PathVariable、@RequestParam

@PathVariable

@PathVariable用于获取路径参数。

value: 字段名称

required:默认为true ,false 时改参数可为空


注意

当required=false时 虽然该参数可以为空但是请求的地址要做一下处理 比如下面sys可为空 请求地址得变为/getSysParameterData/{codeOrName}如果不为空/getSysParameterData/{codeOrName}/{sys}

示例

@GetMapping(value = {"/getSysParameterData/{codeOrName}/{sys}", "/getSysParameterData/{codeOrName}"})
public List getSysParameterData(@PathVariable String codeOrName, @PathVariable(value = "sys", required = false) String sys) {
        return sysParameterService.getSysParameterData(codeOrName, sys);
    }
请求地址:/getSysParameterData/1/2、/getSysParameterData/1

@RequestParam

@RequestParam用于获取查询参数。

name :字段名称

required:默认为true ,false 时改参数可为空

示例


@GetMapping("/getSysParameterData}")
public List getSysParameterData(@RequestParam String codeOrName,@RequestParam(name = "sys", required =false) String sys) {
        return sysParameterService.getSysParameterData(codeOrName, sys);
}
请求地址:/getSysParameterData?codeOrName=1&sys=2、/getSysParameterData?codeOrName=1


4.2. @RequestBody

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

required:默认为true ,false 时改参数可为空

示例

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

请求:

4.3. 前后端交互传递多参数问题

方法一

如果参数过多 使用@RequestBody

方法二

如果参数过多 使用@PathVariable问题如果其中的某一个参数为空的话会报错

解决:后端把所以能为空的 url都写一遍

前端为空时传过来个null可避免写多个url

示例

//如果还有参数无限添加@PathVariable 
//请求地址的变化/getSysParameterData/1/2/...
@GetMapping(value = {"/getSysParameterData/{codeOrName}/{sys}", "/getSysParameterData/{codeOrName}"})
public List getSysParameterData(@PathVariable String codeOrName, @PathVariable(value = "sys", required = false) String sys) {
        return sysParameterService.getSysParameterData(codeOrName, sys);
    }

方法三

如果参数过多 使用@PathVariable+@RequestParam 或者就单独使用@RequestParam

示例

//请求地址的变化/getSysParameterData/1?sys=2...
@GetMapping(value = {"/getSysParameterData/{codeOrName}})
public List getSysParameterData(@PathVariable String codeOrName,@RequestParam(name = "sys", required = false) String sys) {
        return sysParameterService.getSysParameterData(codeOrName, sys);
    }
区别地址的变化 /getSysParameterData/1/2 、/getSysParameterData?codeOrName=1&sys=2

当@PathVariable required=false时 地址必须添加对应传递参数的地址 而@RequestParam则不用

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


5. 读取配置信息

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

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

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

server:
  port: 8087
spring:
  application:
    name: test-service
#  main:
#    allow-bean-definition-overriding: true #当遇到同样名字的时候,是否允

许覆盖注册

# 数据源配置

 datasource: #配置数据源
    url: jdbc:oracle:thin:@192.168.2.4:1521/orcl
    driver-class-name: oracle.jdbc.driver.OracleDriver
    username: pt_test2
    password: dsyf905
testValue: test

5.1. @Value

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

@Value("testValue")

private String testValue;

5.2. @ConfigurationProperties

通过@ConfigurationProperties读取配置信息并与 bean 绑定, 你可以像使用普通的 Spring bean 一样,将其注入到类中使用。

@Component @ConfigurationProperties(prefix = "spring.datasource") //读取yml/Properties里的值
public class BgDataSourcePrefix {


    private String url;
    private String driverClassName;
    private String userName;
    private String password;
    @Value("testValue")
    private String testValue; @Override public String toString() {
        return "BgDataSourcePrefix{" +
                "url='" + url + '\'' +
                ", driverClassName='" + driverClassName + '\'' +
                ", userName='" + userName + '\'' +
                ", password='" + password + '\'' +
                '}';
    }


    public String getUrl() {
        return url;
    }


    public void setUrl(String url) {
        this.url = url;
    }


    public String getDriverClassName() {
        return driverClassName;
    }

5.3. PropertySource(不常用)

@PropertySource读取指定 properties 文件


@Component @PropertySource("classpath:spring.datasource") //读取yml/Properties里的值
public class BgDataSourcePrefix {


    private String url;
    private String driverClassName;
    private String userName;
    private String password;
    @Value("testValue")
    private String testValue; @Override public String toString() {
        return "BgDataSourcePrefix{" +
                "url='" + url + '\'' +
                ", driverClassName='" + driverClassName + '\'' +
                ", userName='" + userName + '\'' +
                ", password='" + password + '\'' +
                '}';
    }


    public String getUrl() {
        return url;
    }


    public void setUrl(String url) {
        this.url = url;
    }


    public String getDriverClassName() {
        return driverClassName;
    }

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 生成):


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. 验证请求参数(@PathVariables、@RequestParam)

一定一定不要忘记在类上加上 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);
    }
}

7. 全局处理Controller层异常

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

相关注解:

@ControllerAdvice :注解定义全局异常处理类

@ExceptionHandler :注解声明异常处理方法

@ControllerAdvice
@ResponseBody
public class GlobalExceptionHandler {


    /**
     * 请求参数异常处理
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request) {
       ......
    }
}

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 中常见的主键生成策略,如下:


枚举替代常量的一种用法


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);
    }
}

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

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

@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声明多对多关系


9. 事务 @Transactional

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

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

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

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

作用于方法:当类配置了@Transactional,方法也配置了@Transactional,方法的事务会覆盖类的事务配置信息。


@Transactional 注解的属性信息

value 和 transactionManager 属性

它们两个是一样的意思。当配置了多个事务管理器时,可以使用该属性指定选择哪个事务管理器。

propagation 属性


事务的传播行为,默认值为 Propagation.REQUIRED。

可选的值有:



Propagation.REQUIRED

如果当前存在事务,则加入该事务,如果当前不存在事务,则创建一个新的事务。



Propagation.SUPPORTS

如果当前存在事务,则加入该事务;如果当前不存在事务,则以非事务的方式继续运行。



Propagation.MANDATORY

如果当前存在事务,则加入该事务;如果当前不存在事务,则抛出异常。



Propagation.REQUIRES_NEW

重新创建一个新的事务,如果当前存在事务,暂停当前的事务。



Propagation.NOT_SUPPORTED

以非事务的方式运行,如果当前存在事务,暂停当前的事务。



Propagation.NEVER

以非事务的方式运行,如果当前存在事务,则抛出异常。



Propagation.NESTED

和 Propagation.REQUIRED 效果一样。

这些概念理解起来实在是有点儿抽象,后文会用代码示例解释说明。


isolation 属性


事务的隔离级别,默认值为 Isolation.DEFAULT。

可选的值有:

Isolation.DEFAULT

使用底层数据库默认的隔离级别。

Isolation.READ_UNCOMMITTED

Isolation.READ_COMMITTED

Isolation.REPEATABLE_READ

Isolation.SERIALIZABLE


timeout 属性

事务的超时时间,默认值为-1。如果超过该时间限制但事务还没有完成,则自动回滚事务。


readOnly 属性

指定事务是否为只读事务,默认值为 false;为了忽略那些不需要事务的方法,比如读取数据,可以设置 read-only 为 true。


rollbackFor 属性

用于指定能够触发事务回滚的异常类型,可以指定多个异常类型。


noRollbackFor 属性

抛出指定的异常类型,不回滚事务,也可以指定多个异常类型。


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. SpringBoot测试

@ActiveProfiles一般作用于测试类上, 用于声明生效的 Spring 配置文件。


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

@Test声明一个方法为测试方法

@Transactional被声明的测试方法的数据会回滚,避免污染测试数据

@WithMockUser Spring Security 提供的,用来模拟一个真实用户,并且可以赋予权限。

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

12. 不常用

@SpringBootConfiguration

这个注解就是 @Configuration 注解的变体,只是用来修饰是 Spring Boot 配置而已,或者可利于 Spring Boot 后续的扩展。


@Conditional

这是 Spring 4.0 添加的新注解,用来标识一个 Spring Bean 或者 Configuration 配置文件,当满足指定的条件才开启配置。


@ConditionalOnBean

组合 @Conditional 注解,当容器中有指定的 Bean 才开启配置。


@ConditionalOnMissingBean

组合 @Conditional 注解,和 @ConditionalOnBean 注解相反,当容器中没有指定的 Bean 才开启配置。


@ConditionalOnClass

组合 @Conditional 注解,当容器中有指定的 Class 才开启配置。


@ConditionalOnMissingClass

组合 @Conditional 注解,和 @ConditionalOnMissingClass 注解相反,当容器中没有指定的 Class 才开启配置。


@ConditionalOnWebApplication

组合 @Conditional 注解,当前项目类型是 WEB 项目才开启配置。


当前项目有以下 3 种类型。


enum Type {


    /**
     * Any web application will match.
     */
    ANY,


    /**
     * Only servlet-based web application will match.
     */
    SERVLET,


    /**
     * Only reactive-based web application will match.
     */
    REACTIVE


}

@ConditionalOnNotWebApplication

组合 @Conditional 注解,和 @ConditionalOnWebApplication 注解相反,当前项目类型不是 WEB 项目才开启配置。


@ConditionalOnProperty

组合 @Conditional 注解,当指定的属性有指定的值时才开启配置。


@ConditionalOnExpression

组合 @Conditional 注解,当 SpEL 表达式为 true 时才开启配置。


@ConditionalOnJava

组合 @Conditional 注解,当运行的 Java JVM 在指定的版本范围时才开启配置。


@ConditionalOnResource

组合 @Conditional 注解,当类路径下有指定的资源才开启配置。


@ConditionalOnJndi

组合 @Conditional 注解,当指定的 JNDI 存在时才开启配置。


@ConditionalOnCloudPlatform

组合 @Conditional 注解,当指定的云平台激活时才开启配置。


@ConditionalOnSingleCandidate

组合 @Conditional 注解,当指定的 class 在容器中只有一个 Bean,或者同时有多个但为首选时才开启配置。


@EnableConfigurationProperties

一般要配合 @ConfigurationProperties 注解使用,用来开启对 @ConfigurationProperties 注解配置 Bean 的支持。


@AutoConfigureAfter

用在自动配置类上面,表示该自动配置类需要在另外指定的自动配置类配置完之后。


如 Mybatis 的自动配置类,需要在数据源自动配置类之后。

@AutoConfigureAfter(DataSourceAutoConfiguration.class)
public class MybatisAutoConfiguration {
@AutoConfigureBefore

这个和 @AutoConfigureAfter 注解使用相反,表示该自动配置类需要在另外指定的自动配置类配置之前。


@Import

这是 Spring 3.0 添加的新注解,用来导入一个或者多个 @Configuration 注解修饰的类,这在 Spring Boot 里面应用很多。


@ImportResource

这是 Spring 3.0 添加的新注解,用来导入一个或者多个 Spring 配置文件,这对 Spring Boot 兼容老项目非常有用,因为有些配置无法通过 Java Config 的形式来配置就只能用这个注解来导入。

推荐阅读

更多模拟面试

全部评论

(22) 回帖
加载中...
话题 回帖

近期热帖

近期精华帖

热门推荐