SpringBoot常用注解

  • @SpringBootApplication
    这个注解是SpringBoot项目的基石,创建SpringBoot项目之后会默认在主类(启动类)上加上。
 
    我们可以把@SpringBootApplication看做是以下几个注解的集合:
  1. @Configuration
  2. @EnableAutoConfiguration
  3. @ComponentScan
 
@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或导入其他配置类
 
 
  • @Autowired
    自动导入对象到类中,被注入进的类同样要被Spring容器管理,比如:Service类注入到Controller类中:
@SpringBootTest
class DemoApplicationTest {
    @Autowired
    private DD dd ;
 
    @Test
    void contextLoads () {
        System. out .println ( "message:" + dd ) ;
    }
}
 
 
 
  • @Component、@Repository、@Service、@Controller
    我们一般使用@Autowired注解让Spring容器帮我们自动装配bean。要想把类标识成可用于@Autowired注解自动装配的bean的类,可以采用如下注解实现:
  1. @Component:通用的注解,可标识任意类为Spring的组件。如果一个bean不知道属于哪个层,可以使用@Component注解标识
  2. @Repository:对应持久层 — DAO层,主要用于数据库相关的操作
  3. @Service:对应服务层,主要涉及一些复杂的逻辑,需要用到DAO层
  4. @Controller:对应SpringMVC控制层,主要负责用户接受用户请求并调用Service层返回对应的数据给前端页面
 
 
  • @RestController
    @RestController注解是@Controller和@ResponseBody的合集,表示这是一个控制器Bean,并且是将函数的返回值直接填入HTTP响应体中,是REST风格的控制器。
 
    单独使用@Controller不加@ResponseBody的话,一般使用在主要返回一个视图的情况下,这种情况属于比较传统的SpringMVC的应用,对应于前后端不分离的情况。@Controller+@ResponseBody返回JSON或者XML形式的数据。
 
 
  • @Scope
    声明Spring Bean的作用域,使用方法:
@Data
@Scope ( "singleton" )
@Component
@ConfigurationProperties ( prefix = "library" )
public class DD {
 
四种常见的作用域:
  1. singleton:唯一bean实例, Spring中创建的bean默认都是单例的
  2. prototype:每次请求都会创建一个新的bean实例
  3. request:每一次http请求都会产生一个新的bean,该bean仅在当前http request内有效
  4. session:每一次http请求都会产生一个新的bean,该bean仅在当前http session内有效
 
 
  • @Configuration
    一般用来声明配置类,可以使用@Component来代替,不过使用Configuration的话更加清晰意义,更加语义话。
 
 
 
常见的HTTP请求类型
 
5中常见的HTTP请求:
  • GET:请求从服务器获取特定的资源。举个例子:GET /user(获取所有的学生)
  • POST:在服务器上创建一个新的资源。举个例子:POST /users(创建学生)
  • PUT:更新在服务器上的资源,客户端提供整个更新后的资源。举个例子:PUT /users/12(更新编号为12的学生)
  • DELETE:从服务器删除特定的资源。举个例子:DELETE /users/12(删除编号为12的学生)
  • PATCH:更新服务上的资源(客户端提供更改的属性,可以看做是部分更新),使用的比较少,不再举例。
 
 
  • GET 请求
    @GetMapping(“value”)
 
 
 
  • POST 请求
    @PostMapping(“value”)
 
 
 
  • PUT 请求
    @PutMapping(“/users/{value}”)
 
 
  • DELETE 请求
    @DeleteMapping(“/users/{value}”)
 
 
 
前后端传值
 
  • @PatchVariable和@RequestParam
    @PathVariable用于获取路径参数,@RequestParam用于获取请求查询参数
 
举个例子:
 
 
  • @RequestBody
    用于读取Request请求(可能是POST、PUT、DELETE、GET)的body部分并且ContentType为application/json格式的数据,接收到数据之后会自动将数据绑定到JAVA对象上去。
 
    系统会使用HttpMessageConverter或者自定义的HttpMessageConverter将请求的body中的json字符串转换为java对象。
 
 
读取配置信息
 
    很多时候,我们需要将一些常用的配置信息,比如阿里云oss、发送短信、微信认证的相关配置信息等等放到配置文件中。
 
    下面我们来看下Spring为我们提供了那些方式帮助我们从配置文件中读取这些配置信息。
 
    我们的数据源application.yml如下:
wuhan2020 : 2020年初武汉爆发了新型冠状病毒,疫情严重,但是,我相信一切都会过去!武汉加油!中国加油!
 
library :
  location : 湖北武汉加油中国加油
  books :
    - name : 天才基本法
      description : 二十二岁的林朝夕在父亲确诊阿尔茨海默病这天,得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校,恰是父亲当年为她放弃的那所。
    - name : 时间的秩序
      description : 为什么我们记得过去,而非未来?时间“流逝”意味着什么?是我们存在于时间之内,还是时间存在于我们之中?卡洛·罗韦利用诗意的文字,邀请我们思考这一亘古难题——时间的本质。
    - name : 了不起的我
      description : 如何养成一个新习惯?如何让心智变得更成熟?如何拥有高质量的关系? 如何走出人生的艰难时刻?
 
 
  • @Value(常用)
    使用@Value(“${property}”)读取比较简单:
@Value ( "${wuhan2020}" )
    private String msg ;
 
    @Test
    void contextLoads () {
        System. out .println ( "message:" + msg ) ;
//        System.out.println("message:"+dd);
    }
 
读取内容:
message:2020年初武汉爆发了新型冠状病毒,疫情严重,但是,我相信一切都会过去!武汉加油!中国加油!
 
 
  • @ConfigurationProperties(常用)
    通过@ConfigurationProperties读取配置信息并与bean绑定:
@Autowired
private DD dd ;
 
@Test
void contextLoads () {
    System. out .println ( "message:" + dd ) ;
}
 
@Data
@Component
@ConfigurationProperties ( prefix = "library" )
public class DD {
    @NotEmpty
    private String location ;
    private List < Book > books ;
 
    @Setter
    @Getter
    @ToString
    static class Book {
        String name ;
        String description ;
    }
}
 
读取内容:
message:DD(location=湖北武汉加油中国加油, books=[DD.Book(name=天才基本法, description=二十二岁的林朝夕在父亲确诊阿尔茨海默病这天,得知自己暗恋多年的校园男神裴之即将出国深造的消息——对方考取的学校,恰是父亲当年为她放弃的那所。), DD.Book(name=时间的秩序, description=为什么我们记得过去,而非未来?时间“流逝”意味着什么?是我们存在于时间之内,还是时间存在于我们之中?卡洛·罗韦利用诗意的文字,邀请我们思考这一亘古难题——时间的本质。), DD.Book(name=了不起的我, description=如何养成一个新习惯?如何让心智变得更成熟?如何拥有高质量的关系? 如何走出人生的艰难时刻?)])
 
    你可以像使用普通的Spring Bean一样,将其注入到类中使用。
 
 
参数校验
 
数据校验的重要性不用多说,即使前端对于数据有了校验,但是后端仍然要对于数据进行校验,避免用户绕过前端直接访问后端请求一些违法的数据。
 
    JSR 是一套JavaBean参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加到我们的JavaBean的属性上面,这样就可以在需要校验的时候进行校验了,非常方便。
 
 
    一些常用的数据校验的注解:
  • @NotEmpty:被注释的字符串不能为空也不能为null
  • @NotBlack:被注释的字符串非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=):被注释的元素的大小必须在指定的范围内(比较字符串、集合、map等的长度)
  • @Digits(integer,fraction):被注释的元素必须是一个数字,其值必须在可接受的范围内
  • @Past:被注释的元素必须是一个过去的日期
  • @Future:被注释的元素必须是一个将来的日期
  • …...
 
 
  • 验证请求
 
我们需要在验证的参数上加上@Valid注解,如果验证失败,它将抛出MethodArgumentNotValidException异常。
 
 
 
  • 验证请求参数
    一定一定不要忘记在类上加上@Validated注解,这个参数可以告知Spring去校验方法参数
 
 
区别:
@Valid:用于校验对象中成员变量、方法、方法参数。
@Validated:可以用在类型、方法、方法参数。但是不能应用于成员变量。
 
 
  • 全局处理Controller层异常
 
    介绍下我们Spring项目必备的全局处理Controller层异常。
 
相关注解:
 
  1. @ControllerAdvice:注解定义全局异常处理类
  2. @ExceptionHandler:注解声明异常处理方法
 
    如何使用?拿参数校验这里来举例子。如果方法参数不对的话会抛出  MethodArgumentNotValidException
 
我们来处理下这个异常:
 
 
事务
 
  • @Transactional
    在要开启事务的方法上使用@Transactional注解:
 
    我们知道Exception分为运行异常和非运行异常。在@Transactional注解中如果不配置rollbackFor属性,那么事务只有在遇到运行时异常的时候才会回滚。
 
作用域:
作用类上:表示类中所有的public方法都事务回滚
作用方法上:该方法回滚
 
声明:注意事务的时效6中场景,感兴趣自行了解。
 
 
测试相关
 
    其实,发现很多人并不注重单元测试,所有有必要说明下:
 
  • @ActiveProfiles
    一般用于测试类上,用于声明生效的Spring配置文件。(这可以根据实际场景选择对应的配置文件来跑单元测试,不必要每次都修改配置文件)
 
  • @Test 不多赘述
 
  • Transactional 被声明的测试方法的数据会回滚,避免污染测试数据
    这个有必要说明下,测试完后数据还原,不要每一次测试就改掉了测试数据。避免重复造测试数据,很麻烦。
 
  • WithMockUser
    Spring Security提供的,用来模拟一个真实的用户,并且可以赋予权限。
 
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值