springboot注解详细介绍

注解(annotations)列表

(1)@SpringBootApplication:包含了@ComponentScan,@Configuration和@EnableAutoConfiguration注解注解，其中@ComponentScan让spring boot扫描到Configuration类并把它加入到程序上下文。

(2)@Configuration 等同于spring的XML配置文件；使用java代码可以检查类别安全。

(3)@EnableAutoConfiguration自动配置

(4)@ComponentScsn 组件扫描，可自动发现和装配一些Bean。

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

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

(7)@Autowired自动注入。

(8)PathVariable 获取参数。

(9)JsonBackReference解决嵌套外链问题。

(10) @RepositoryRestResourcepublic配合spring-boot-starter-data-rest使用。

                                                    注解(annotations)详解

@SpringBootApplication:申明让spring boot自动给程序进行必要的配置，这个配置等同于:@Configuration,@EnableAutoConfiguration和@ComponentScan三个配置。

1.  
   package com.example.myproject;
2.  
   import org.springframework.boot.SpringApplication;
3.  
   import org.springframework.boot.autoconfigure.SpringBootApplication;
4.  
    
5.  
   @SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
6.  
   public class Application {
7.  
   public static void main(String[] args) {
8.  
   SpringApplication.run(Application.class, args);}
9.  
   }

  @ResponseBody：表示该方法的返回结果直接写入HTTP response body中，一般在异步获取数据时使用，用于构建RESTful的API。在使用@ResquestMapping后，返回值通常解析为跳转路径，加上@ResponseBody后返回结果不会被解析为跳转路径，直接写入HTTP response body中。比如异步获取json数据，加上@Responsebody后，会直接返回json数据。该注解一般会配合@RequestMappin一起使用。示例代码如下：

1.  
   @RequestMapping(“/test”)
2.  
   @ResponseBody
3.  
   public String test(){
4.  
   return”index”;
5.  
   }

@Controller:用于定义控制器类，在spring项目中控制器负责将用户发来的URL请求转发到对应的接口服务(service层)，一般这个注解在类中，通常方法需要配合注解@RequestMapping使用，例如下面代码：

1.  
   @Controller
2.  
   @RequestMapping(“/demo”)
3.  
   publicclass DemoController {
4.  
   @Autowired
5.  
   private DemoInfoService demoInfoService;
6.  
    
7.  
   @RequestMapping("/hello")
8.  
   public String hello(Map<String,Object> map){
9.  
   System. out.println("DemoController.hello()");
10.  
    map.put( "hello","from TemplateController.helloHtml");
11.  
    //会使用hello.html或者hello.ftl模板进行渲染显示.
12.  
    return"/hello";}
13.  
    }

@RestController:用于标注控制层组件(如struts中的action)，@ResponseBody和@Controller的合集。@RestController = @ResponseBody + @Controller。实例如下：

1.  
   package com.kfit.demo.web;
2.  
    
3.  
   import org.springframework.web.bind.annotation.RequestMapping;
4.  
   import org.springframework.web.bind.annotation.RestController;
5.  
    
6.  
   @ RestController
7.  
   @RequestMapping(“/demoInfo2”)
8.  
   publicclass DemoController2 {
9.  
   @ RequestMapping("/test")
10.  
    public String test(){
11.  
    return"ok";
12.  
    }
13.  
    }

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

@EnableAutoConfiguration:springboot自动配置(auto-configuration):尝试根据你添加的jar依赖自动配置你的spring应用。 

如果你的calsspath下存在HSALDB，并且你没有手动配置任何数据库连接的beans,那么我们将自动配置一个内存型(in-memory)数据库。可以将@EnableAutoConfiguration或者@SpringBootApplication注解添加到一个@Configuration类上来选择自动配置。如果发现应用了不想要的特定自动配置类，可是使用@EnableAutoConfiguration注解的排除属性类禁用它们。

@ComponentScan:表示将该类自动发现扫描组件。

扫描到有@Component,@Controller,.@Service等这些注解的类，并注册为Bean,可以自动收集所有的Spring组件，包括@Configuration注解的类。经常使用@ComponentScan注解搜索beans，并结合@Autowried注解导入。如果没有配置的话，Spring boot会扫描自动类所在包下以及子包下使用了@Service,@Respository等注解的类。

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

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

@ImpoertResouce:用来加载xml配置文件。

@AutoWired:自动导入依赖的bean.

@Service：一般用于修饰service层的组件。

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

@Repository:使用@Repository注解可以确保DAO或者respositories提供异常转译，这个注解修饰的DAO或者respositories类会被CompoonentScan返现并配置，同时也不需要为他们提供XML配置项。

@Bean:用于@Bean标注方法等价于XML中配置的bean.

@Value：注入Spring boot application.properties配置的属性的值。示例代码：

@Value(value = "#{message}")

private String message;

@Inject:等价于默认的@Autowried,只是没哟required属性。

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

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

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

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

1.  
   @Autowired
2.  
   @Qualifier(value = “demoInfoService”)
3.  
   private DemoInfoService demoInfoService;

• • @Resource(name=”name”,type=”type”)：没有括号内内容的话，默认byName。与@Autowired干类似的事。

    三、JPA注解

  • @Entity：@Table(name=”“)：表明这是一个实体类。一般用于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。

  • 四、springMVC相关注解

    @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：用在方法的参数前面。
    2.  
       @RequestParam
    3.  
       String a =request.getParameter(“a”)。
    4.  
        
    5.  
       @PathVariable:路径变量。如
    6.  
       RequestMapping(“user/ get/mac/{macAddress}”)
    7.  
       public String getByMacAddress(@PathVariable String macAddress){
    8.  
       //do something;
    9.  
       }
    10.  
        参数与大括号里的名字一样要相同。

    五、全局异常处理

  • @ControllerAdvice：包含@Component。可以被扫描到。统一处理异常。

  • @ExceptionHandler（Exception.class）：用在方法上面表示遇到这个异常就执行以下方法。

  •  

  • @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配置文件中的一对一，一对多，多对一。

转载于:https://www.cnblogs.com/xiaohanhan1991/p/10058271.html