首页 > 编程语言 > 详细

SpringBoot注解

时间:2021-01-13 23:44:40      阅读:33      评论:0      收藏:0      [点我收藏+]

springboot有哪些常用注解?

 

springboot中的常用注解有:@SpringBootApplication、@Repository、@Service、@RestController、@ResponseBody、@Component、@ComponentScan等等。下面本篇文章就来给大家介绍一下,希望对大家有所帮助。

 

  1. @SpringBootApplication

这个注解是Spring Boot最核心的注解,用在 Spring Boot的主类上,标识这是一个 Spring Boot 应用,用来开启 Spring Boot 的各项能力。实际上这个注解是@Configuration,@EnableAutoConfiguration,@ComponentScan三个注解的组合。由于这些注解一般都是一起使用,所以Spring Boot提供了一个统一的注解@SpringBootApplication

  1. @EnableAutoConfiguration

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

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

@EnableAutoConfiguration实现的关键在于引入了AutoConfigurationImportSelector,其核心逻辑为selectImports方法,逻辑大致如下:

  从配置文件META-INF/spring.factories加载所有可能用到的自动配置类;

  去重,并将excludeexcludeName属性携带的类排除;

  过滤,将满足条件(@Conditional)的自动配置类返回;

  1. @Configuration

用于定义配置类,指出该类是 Bean 配置的信息源,相当于传统的xml配置文件,一般加在主类上。如果有些第三方库需要用到xml文件,建议仍然通过@Configuration类作为项目的配置主类——可以使用@ImportResource注解加载xml配置文件。

  1. @ComponentScan

组件扫描。让spring Boot扫描到Configuration类并把它加入到程序上下文。

@ComponentScan注解默认就会装配标识了@Controller@Service@Repository@Component注解的类到spring容器中。

  1. @Repository

用于标注数据访问组件,即DAO组件。

使用@Repository注解可以确保DAO或者repositories提供异常转译,这个注解修饰的DAO或者repositories类会被ComponetScan发现并配置,同时也不需要为它们提供XML配置项。

可以理解为加入该注解的类会被自动注入到spring容器中进行管理。

  1. @Service

一般用于修饰service层的组件,可以理解为加入该注解的类会被自动注入到spring容器中进行管理。

  1. @Controller

@Controller表示在tomcat启动的时候,把这个类作为一个控制器加载到SpringBean工厂,如果不加,就是一个普通的类,和Spring没有半毛钱关系。

其中,base-package表示会扫描com.blogMgr目录下所有的包,一旦发现有个类上面加了类似于@Controller的注解,在容器启动的时候系统就会把它加载到SpringBean工厂,并且对其实例化。

这也是为什么,我们只是写了Controller,但是从来没有在一个地方new这个Controller的原因,因为在Web容器启动的时候,这个Controller已经被Spring加载到自己的Bean工厂里面去了。

这也就是所谓的Spring扫包机制。@Controller就是一个注解,当tomcat启动,我们会看到一些JAVA类挥舞着印有@Controller的旗子大喊:" HeySpringMVCI‘m  here,please take me to your bean factory!"

  1. @RestController

用于标注控制层组件(struts中的action),表示这是个控制器bean,并且是将函数的返回值直 接填入HTTP响应体中,REST风格的控制器;它是@Controller@ResponseBody的合集。

  1. @RequestMapping

RequestMapping是一个用来处理请求地址映射的注解;提供路由信息,负责URLController中的具体函数的映射,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。

  1. @RequestParam

用在方法的参数前面将请求参数绑定到你控制器的方法参数上。例:

 

  1. @RequestBody

@RequestBody主要用来接收前端传递给后端的json字符串中的数据的(请求体中的数据的(如:请求参数)

GET方式无请求体,所以使用@RequestBody接收数据时,前端不能使用GET方式提交数据,而是用POST方式进行提交。在后端的同一个接收方法里,@RequestBody@RequestParam()可以同时使用,@RequestBody最多只能有一个,而@RequestParam()可以有多个。

RequestBody 接收的是请求体里面的数据;而RequestParam接收的是key-value
里面的参数

  1. @ResponseBody

表示该方法的返回结果直接写入HTTP response body

一般在异步获取数据时使用,在使用@RequestMapping后,返回值通常解析为跳转路径,加上@responsebody后返回结果不会被解析为跳转路径,而是直接写入HTTP response body中。比如异步获取json数据,加上@responsebody后,会直接返回json数据。

 

  1. @CrossOrigin

用在后端解决前后端跨域问题

跨域,指的是浏览器不能执行其他网站的脚本。它是由浏览器的同源策略造成的,是浏览器对JavaScript施加的安全限制。

所谓同源是指,域名,协议,端口均相同

 

出于安全原因,浏览器禁止Ajax调用驻留在当前原点之外的资源。例如,当你在一个标签中检查你的银行账户时,你可以在另一个选项卡上拥有EVILL网站。来自EVILL的脚本不能够对你的银行API做出Ajax请求(从你的帐户中取出钱!)使用您的凭据。

  跨源资源共享(CORS)是由大多数浏览器实现的W3C规范,允许您灵活地指定什么样的跨域请求被授权,而不是使用一些不太安全和不太强大的策略,如IFRAMEJSON

 

  1. @Component

泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。

  1. @Bean

相当于XML中的<bean></bean>,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理。

  1. @AutoWired

byType方式。把配置好的Bean拿来用,完成属性、方法的组装,它可以对类成员变量、方法及构造函数进行标注,完成自动装配的工作。

当加上(required=false)时,就算找不到bean也不报错。

  1. @Qualifier

当有多个同一类型的Bean时,可以用@Qualifier("name")来指定。与@Autowired配合使用

  1. @Resource(name="name",type="type")

没有括号内内容的话,默认byName。与@Autowired干类似的事。

  1. @Transient

游离态的,临时的,被该注解标注的属性,不用持久化到数据库。如果前后端的接口(方法)不一致时,可以在后端实体类中临时添加一个和前端定义的一样的接口属性。

  1. @GeneratedValue

1)、@GeneratedValue注解存在的意义主要就是为一个实体生成一个唯一标识的主键、@GeneratedValue提供了主键的生成策略

2)、@GeneratedValue注解有两个属性,分别是strategygenerator,

注意默认SpringBoot@GeneratedValue 是不需要加参数的,但是如果数据库控制主键自增(auto_increment), 不加参数就会报错

  1. @Id

Id 标注用于声明一个实体类的属性映射为数据库的主键列。该属性通常置于属性声明语句之前,可与声明语句同行,也可写在单独行上。

@Id标注也可置于属性的getter方法之上。

@GeneratedValue@Id不能一个在属性上,一个在getter方法上,其他注解也是一样

  1. @Colum

用来标识实体类中属性与数据表中字段的对应(映射)关系

@column标记表示所持久化属性所映射表中的字段

  1. @Param

@ParamMyBatis所提供的(org.apache.ibatis.annotations.Param),作为Dao层的注解,作用是用于传递参数,从而可以与SQL中的的字段名相对应,一般在2=<参数数<=5时使用最佳。

了解:当只有一个参数时,没什么好说的,传进去一个值也只有一个参数可以匹配。当存在多个参数时,传进去的值就区分不开了,这时可以考虑用Map

 

  1. @PathVariable

 

路径变量。参数与大括号里的名字一样要相同。例:

 

RequestMapping("user/get/mac/{macAddress}")

public String getByMacAddress(@PathVariable String macAddress){

  //do something;

}

  1. @Profiles

Spring Profiles提供了一种隔离应用程序配置的方式,并让这些配置只能在特定的环境下生效

任何@Component@Configuration都能被@Profile标记,从而限制加载它的时机。

 

@Configuration

@Profile("prod")

public class ProductionConfiguration {

    // ...

}

  1. @ConfigurationProperties

Spring Boot可使用注解的方式将自定义的properties文件映射到实体bean中,比如config.properties文件。

 

@Data

@ConfigurationProperties("rocketmq.consumer")

public class RocketMQConsumerProperties extends RocketMQProperties {

    private boolean enabled = true;

    private String consumerGroup;

    private MessageModel messageModel = MessageModel.CLUSTERING;

    private ConsumeFromWhere consumeFromWhere = ConsumeFromWhere.CONSUME_FROM_LAST_OFFSET;

    private int consumeThreadMin = 20;

    private int consumeThreadMax = 64;

    private int consumeConcurrentlyMaxSpan = 2000;

    private int pullThresholdForQueue = 1000;

    private int pullInterval = 0;

    private int consumeMessageBatchMaxSize = 1;

    private int pullBatchSize = 32;

}

SpringBoot注解

原文:https://www.cnblogs.com/heikedeblack/p/14274758.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!