SpringBoot注解大全

SpringBoot注解大全

  1. 注解(annotations)列表

    • @SpringBootAppliation:包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让[Spring] Boot扫描到Configruation类并把它加载到程序上下文中

    • Configruation等同于spring的xml配置文件;使用[java]代码可以检查类型安全

    • EnableAutoConfiguration自动配置

    • @ComponentScan组件扫描,可自动发现和装配一些Bean

    • @Component可配合CommandLineRunner使用,在程序启动后执行一些基础任务

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

    • @Autowired自动导入

    • @PathVariable获取参数

    • @JsonBackReference解决嵌套外联问题

  2. 注解详情
    • @SpringBootApplication:声明让SpringBoot自动给程序进行必要的配置,这个配置等同于:@Configuration、@EnableAutoConfiguration和@ComponentScan三个配置

      • 这个注解在SpringBoot中是非常重要的,我们都知道在使用SpringBoot框架时,会有一个入口类,而这个入口必须标名有@SpringBootApplication

    • @ResponseBody:表示该方法的返回结果直接写入HTTP response body中,一般在异步获取数据时使用,用于构建RESTful的api。在使用@RequestMapping后,返回值通常解析为跳转路径,加上@ResponseBody后返回结果不会被解析为跳转路径,而是直接写入到HTTP response body中,比如异步获取json数据,加上@ResponseBody后会直接返回json数据,该注解一般会配合@RequestMapping一起使用

    • @Controller:用于定义控制器类,在Spring项目中由控制器负责将用户发过来的URL请求转发到对应的服务接口(Sevice层),一般这个注解在类中,通常方法需要配合@RequestMapping一起使用

    • @RestController:用于标注控制层组件(如struts中的action),@ResponseBody和@Controller的合集

    • @RequestMapping:提供路由信息,负责URL到Controller中的具体函数的映射

    • @EnableAutoConfigruation:SpringBoot自动配置(auto-configuration):尝试根据添加的jar依赖自动配置你的Spring应用。例如,如果你的calsspath下存在HSQLDB,并且你没有手动配置任何数据库连接的beans,那就会自动配置一个内存型数据库。你可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置,如果发现 应用了你不想要的特定配置类,可以使用@EnableAutoConfiguration注解的排除属性来禁用它们。

    • @ComponentScan:表示将该类自动发现扫描组件,可以这样理解,如果扫描到@Component、@Controller、@Service等这些注解的类,并注册为Bean,可以自动收集所有的Sping组件,包括@Configuration类。我们经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入,可以自动收集所有的Spring组件@Configuration类。还有就是经常使用@ComponentScan注解搜索beans,并结合@Autowired注解导入。如果没有配置的话,SpringBoot会扫描启动类所在包下以及子包下的使用了@Service,@Repository等注解的类

    • @Configuration:相当于传统的xml配置文件,如果有一些第三方库需要使用到xml文件,建议仍然通过@Configuration类作为作为项目的配置主类--可以使用@ImportResource注解加载xml配置文件

    • @Import:用来导入其他配置类

    • @ImportResource:用来加载xml配置文件

    • @Autowired:自动导入依赖的bean

    • @Service:一般用来修饰service层组件

    • @Repositoy:使用@Repositoy注解可以确保DAO或者repository提供异常转译,这个注解修饰的DAO或者repository类会被ComponentScan发现并配置,同时也不需要为它们提供xml配置项

    • @Bean:用此注解标注方法等价于xml配置的bean

    • @Value:注入Spring Boot application.properties(或者.yml)配置的属性值

    • @Inject:等价于默认@Autoired,只是没有required属性

    • @Component:泛指组件,当组件不好归类的时候,可以使用此注解

    • @Bean:相当于xml中的,放在方法的上面,而不是类,意思是产生一个bean,并交给spring管理

    • @Autowired:自动导入依赖的bean.byType方式,把配置好的bean拿来用,完成属性、方法的组装,他可以对类成员变量、方法、构造参数进行标注,完成自动装配工作‘.当加上(required=false)时,就算找不到bean也不报错

    • @Qualifier:当有多个同一类型的bean时,可以使用@Qualifier("name")来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,还能进行更细粒度的控制如何选择候选者

  3. JPA注解
    • @Entity:@Table(name=""):表明这是一个实体类,一般用于jpa,一般这两个注解一块使用,但是如果表明与实体类名称相同的话@Table可以省略

    • @MappedSuperClass:用于确定时父类的repository,父类的属性子类可以继承

    • @NoRepositoryBean:一般用作父类的repository,有这个注解,Spring不回去实例化该repository

    • @Column:如果字段名与列明相同,可以省略

    • @Id:表示该属性为主键

    • @GeneratedValue(strategy=GenerationType.SEQUENCE,generator="repair_seq"):表示主键生成策略是sequence(可以为Auto、IDENTITY、native等,Auto表示可以在多个数据库间切换),指定sequence的名字是repair_seq

    • @SequenceGenerator(name="repair_seq",seqenceName="seq_repair",allocationSize=1):name为sequence名称,以便使用,sequenceName为数据库的Sequence名称,两个名称可以一致

    • @Transient:表示该属性并非一个到数据库表的字段的映射,ORM框架将忽略该属性,如果一个属性并非数据库表的字段映射,就务必将其标记为@Transient,否则,ORM框架默认值其注解为@Basic.@Basic(fetch=FetchType.LAZY):标记可以指定实体属性的加载方式

    • JsonIgnore:作用是json序列化时将[java]bean中的一些属性忽略掉,序列化和反序列化都受影响

    • @JoinColumn(name="loginId"):一对一:本表中指向另一个表的外键。一对多:另一个表指向本表的外键

    • @OneToOne、@OneToMany、@ManyToOne:对应(hibernate、Spring)配置文件中的对应关系

  4. SpringMVC相关注解

    • @RequestMapping:@RequestMapping("/path")表示该控制器处理所有"/path"的URL请求。RequestMapping是一个用来处理请求地址映射的注解,可用于类或者方法上

      • 当用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有以下六个属性:

        1. params:指定request中必须包含某些指定的params值,才让该方法处理

        2. headers:指定request中必须包含某些指定的headers值,才能让该方法处理请求

        3. value:指定请求的实际地址,指定的地址可以是URITemplate模式

        4. method:指定请求的method类型,GET、POST、PUT、DELETE等

        5. consumes:指定处理请求的提交内容类型(ContentType),如application/json,text/html

        6. produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回

    • @Requestparams:用在方法的参数面前

    • @PathVariable:路径变量

  5. 全局异常处理
    • @ControllerAdvice:包含@Component.可以被扫描到。统一处理异常

    • @ExceptionHandler(Exception.class):用在方法上面表示遇到这个异常就执行一下方法

原文地址:https://www.cnblogs.com/juddy/p/13587104.html