Spring Boot注解

302 阅读6分钟
原文链接: blog.csdn.net
一 、注解列表
  1. @SpringBootApplication: 包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让Spring Boot扫描到Configuration类并把它加入到程序上下文。

  2. @Configuration: 等同于Spring的XML配置文件;使用Java代码可以检查类型安全。

  3. @EnableAutoConfiguration: 自动配置。

  4. @ComponentScan: 组件扫描,可自动发现和配置一些Bean。

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

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

  7. @Autowired: 自动导入。

  8. @PathVariable: 获取参数。

  9. @JsonBackReference: 解决嵌套外链问题。

  10. @RepositoryRestResourcepublic: 配合spring-boot-starter-data-rest使用。

二 、注解详解
  1. @SpringBootApplication: 申请让Spring Boot自动给程序进行必要的配置,这个配置等同于@ComponentScan、@Configuration和@EnableAutoConfiguration三个配置
package com.example.project;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}
  1. @ResponseBody: 表示该方法的返回结果直接写入HTTP response中,一般在异步获取数据时使用,用于构建Restful风格的API。在使用@RequestMapping注解后,返回值解析为跳转路径,加上@ResponseBody注解后返回结果不会被解析为跳转路径,而是直接写入到HTTP response body中。比如异步获取json数据,加上@ResponseBody注解后,会直接返回Json数据。该注解一般会配合@RequestMapping一起使用:
@RequestMapping(“/test”)
@ResponseBody
public String test(){
    return”ok”;
}
  1. @Controller: 用于定义控制器类,在spring项目中由控制器负责将用户发来的URL请求转发到对应的服务接口,一般这个注解在类中要和@RequestMapping注解配合使用。
@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

    @RequestMapping("/hello")
    public String hello(Map map){
        System.out.println("DemoController.hello()");
        map.put("hello","from TemplateController.helloHtml");
        //会使用hello.html或者hello.ftl模板进行渲染显示.
        return"/hello";
    }
}
  1. @RestController: 用于标注控制层组件,@ResponseBody注解和@Controller注解的组合。
package com.demo.web;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping(“/demoInfo2”)
publicclass DemoController2 {

    @RequestMapping("/test")
    public String test(){
        return"ok";
    }
}
  1. @RequestMapping: 提供路由信息,负责URL到Controller中的具体函数映射。

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

  3. @ComponentScan: 定义扫描的路径从中找出标识了需要装配的类自动装配到spring的bean容器中

  4. @Configuration: 相当于XML文件,如果有些需要第三方库需要用到XML文件,建议使用@Configuration类作为项目的配置主类。

  5. @Import: 来导入其它配置类。

  6. @ImportResource: 来加载XML配置文件。

  7. @Autowired: 自动导入依赖的Bean。

  8. @Service: 用于修饰service层的组件。

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

  10. @Bean: 用此注解等价于XML中配置Bean。

  11. @value: 注入Spring boot application.properties配置的属性的值。

@Value(value = “#{info}”)
private String message;
  1. Inject: 等价于默认的@Autowried,只是没有required属性。

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

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

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

  5. @Qualifier: 当有多个同一类型的Bean时,可以用@Qualifier(“name”)来指定。与@Autowired配合使用。@Qualifier限定描述符除了能根据名字进行注入,但能进行更细粒度的控制如何选择候选者,具体使用方式如下:

@Autowired
@Qualifier(value = “demoInfoService”)
private DemoInfoService demoInfoService;
  1. @Resource(name=”name”,type=”type”): 没有括号内内容的话,默认byName。与@Autowired干类似的事。
三 、JPA注解
  • @Entity: 表名这是一个实体类。一般用于JPA这两个注解一般一块使用,但是如果表名和实体类名相同的话,@Table可以省略

  • @MappedSuperClass: 用在确定是父类的entity上。父类的属性子类可以继承。

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

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

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

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

  • @SequenceGeneretor(name = “repair_seq”, sequenceName = “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配置文件中的一对一,一对多,多对一。

四 、SpringMVC注解
  1. @RequestMapping: @RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。
    RequestMapping是一个用来处理请求地址映射的注解,可用于类或方法上。用于类上,表示类中的所有响应请求的方法都是以该地址作为父路径。
    该注解有六个属性:
  • params:指定request中必须包含某些参数值是,才让该方法处理。
  • headers:指定request中必须包含某些指定的header值,才能让该方法处理请求。
  • value:指定请求的实际地址,指定的地址可以是URI Template 模式
  • method:指定请求的method类型, GET、POST、PUT、DELETE等
  • consumes:指定处理请求的提交内容类型(Content-Type),如application/json,text/html;
  • produces:指定返回的内容类型,仅当request请求头中的(Accept)类型中包含该指定类型才返回
  1. @RequestParam: 用在方法的参数前面。
    @RequestParam
    String a =request.getParameter(“a”)。

  2. @PathVariable: 路径变量。如

RequestMapping(“user/get/mac/{macAddress}”)
public String getByMacAddress(@PathVariable String macAddress){
    //do something;
}

来源:www.cnblogs.com/tanwei81/p/…