spring&&springboot注解大全 待更新

• 一、注解（annotations）列表
• 二、注解（annotations）详解
• 三、JPA注解
• 四、springMVC相关注解
• 五、全局异常处理

————————————————————

一、 注解（annotations）列表

@SpringBootApplication：

包含了@ComponentScan、@Configuration和@EnableAutoConfiguration注解。其中@ComponentScan让spring Boot扫描到Configuration类并把它加入到程序上下文。

@Configuration:

等同于spring的XML配置文件；使用java代码可以检查类型安全。

@EnableAutoConfiguration：

自动配置 。springboot的核心注解。能根据类路径下的jar包和配置动态加载配置和注入bean。
举个例子：
比如我在lib下放一个druid连接池的jar包，然后再application.yml文件配置druid相关的参数，SpringBoot就能够自动配置所有我们需要的东西，如果我把jar包拿掉或者参数去掉，那springboot就不会自动配置了。

由于有这个注解的存在，我们可以把许多功能做成公共的自动配置的启动器（starters）,其实druid连接池就是这么做的，它提供了针对Springboot的启动器：druid-spring-boot-Starter。

@ComponentScan：

组件扫描，可自动发现和装配一些Bean。

@Component:

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

@RestController:

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

@Autowired：

自动导入：可以对类成员变量、方法及构造函数进行标注，完成自动装配的工作。通过@Autowired的使用来消除
set、get方法。在使用@Autowired之前，我们对一个bean配置起属性时，是这样用的：

<property name="属性名" value=" 属性值"/>  

通过这种方式来，配置比较繁琐，而且代码比较多。在Spring 2.5 引入了@Autowired注解。

@PathVariable:

获取参数；@PathVariable是spring3.0的一个新功能：接收请求路径中占位符的值

语法：

@PathVariable("XXX")
//通过@PathVariable可以将URL中占位符参数{XXX}绑定到处理器类的方法形参中@PathVariable("XXX")
@RequestMapping(value="user/{id}/{name}")
//请求路径

@Controller
@RequestMapping("hello")
public class HelloController2 {
    /**
     *3、占位符映射
     * 语法：@RequestMapping(value=”user/{userId}/{userName}”)
     * 请求路径：http://localhost:8080/hello/show5/1/james
     * @param ids
     * @param names
     * @return
     */
    @RequestMapping("show5/{id}/{name}")
    public ModelAndView test5(@PathVariable("id") Long ids ,@PathVariable("name") String names){
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","占位符映射：id:"+ids+";name:"+names);
        mv.setViewName("hello2");
        return mv;
    }
}

@JsonBackReference:

解决嵌套外链问题。jackson中的@JsonBackReference和@JsonManagedReference,以及@JsonIgnore均是为了解决对象中存在双向引用导致的无限递归（infinite recursion）问题。这些标注均可用在属性或对应的get和set方法中。
其中@JsonBackReference和@JsonManagedReference：这两个标注通常配对使用，通常用在父子关系中。
@JsonBackReference标注的属性在序列化（serialization，即将对象转化为json数据）时，会被忽略（即结果中的json数据不包含该属性的内容）。@JsonManagedReference标注的属性则会被序列化。在序列化时，@JsonBackReference的作用相当于@JsonIgnore，此时可以没有@JsonManageReference。但在反序列化（deserialization，即json数据转换为对象）时，如果没有@JsonManageReference，则不会自动注入@JsonBackReference标注的属性（被忽略的父或子）；如果有@JsonManageReference,则会自动注入@JsonBackReference标注的属性。

@JsonIgnore:

直接忽略某个属性，以断开无限递归，序列化或反序列化均被忽略。当然如果标注在get、set方法中，则可以分开控制，序列化对应的时get方法，反序列化对应的是set方法。在父子关系中，当反序列化时，@JsonIgnore不会自动注入被忽略的属性值（父或子），这是它跟@JsonBackReference和@JosnManagedReference最大的区别。

@RepositoryResourcepublic：

配合spring-boot-starter-data-rest使用。

二、注解（annotations）详解

——————————————————————————————————————————————————

@SpringBootApplication:

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

package com.example.myproject;
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);
    }
}

@RespomseBody :

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

@RequestMapping(“/test”)
@ResponseBody
public String test(){
    return”ok”;
}

@Controller：

用于定义控制类，在spring项目中自由控制负责将用户发来的URL请求转发到对应的服务接口（service层），一般在这个注解类中，通常方法需要配合注解@RequestMapping。示例代码：

@Controller
@RequestMapping(“/demoInfo”)
publicclass DemoController {
    @Autowired
    private DemoInfoService demoInfoService;

    @RequestMapping("/hello")
    public String hello(Map<String,Object> map){
        System.out.println("DemoController.hello()");
        map.put("hello","from TemplateController.helloHtml");
        //会使用hello.html或者hello.ftl模板进行渲染显示.
        return"/hello";
    }
}

@RestController：

用于标注控制层组件（如struts中的action），@ResponseBody和@Controller的合集。示例代码：

package com.kfit.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";
    }
}

@RequestMapping:

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

@EnableAutoConfiguration：

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

@ComponentScan：

表示该类自动发现扫描组件。个人理解相当于，如果扫描到有@Component、@Controller、@Service等这些注解的类，并注册为Bean，可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。可以自动收集所有的Spring组件，包括@Configuration类。我们经常使用@ComponentScan注解搜索beans，并结合@Autowired注解导入。如果没有配置的话，Spring Boot会扫描启动类所在包下以及子包下的使用了@Service，@Reposity等注解的类。

@Cofiguration：

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

@Import：

用来导入其他配置类。

@ImportResource：

用来加载xml配置文件。

@Autowired：

自动导入依赖的bean

@Service：

一般用于修饰service层的组件

@Repository：

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

@Bean：

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

@value：

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

@Value(value = “#{message}”)
private String message;

@Inject：

等价于默认的@Autowired，只是没有required属性；

@Component：

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

@Bean：

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

@Autowired：

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

@Qualifier：

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

@Autowired
@Qualifier(value = “demoInfoService”)
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。

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

@RequestMapping：

@RequestMapping(“/path”)表示该控制器处理所有“/path”的UR L请求。RequestMapping是一个用来处理请求地址映射的注解，可用于类或方法上。
用于类上，表示类中的所有响应请求的方法都是以该地址作为父路径。该注解有六个属性：

1、params:指定request中必须包含某些参数值是，才让该方法处理。
2、headers:指定request中必须包含某些指定的header值，才能让该方法处理请求。
3、value:指定请求的实际地址，指定的地址可以是URI Template 模式
4、method:指定请求的method类型， GET、POST、PUT、DELETE等。
5、consumes:指定处理请求的提交内容类型（Content-Type），如application/json,text/html;
6、produces:指定返回的内容类型，仅当request请求头中的(Accept)类型中包含该指定类型才返回（@RequestParam：用在方法的参数前面。
@RequestParam
String a =request.getParameter(“a”)。
@PathVariable:路径变量。如

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

）
参数与大括号里的名字一样要相同。

五、全局异常处理

@ControllerAdvice：

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

@ExceptionHandler（Exception.class）：

用在方法上面表示遇到这个异常就执行以下方法。
通常一个web程序在运行过程中，由于用户的操作不当，或者程序的bug，有大量需要处理的异常。其中有些异常是需要暴露给用户的，比如登陆超时，权限不足等等。可以通过弹出提示信息的方式告诉用户出了什么错误。

而这就表示在程序中需要一个机制，去处理这些异常，将程序的异常转换为用户可读的异常。而且最重要的，是要将这个机制统一，提供统一的异常处理。因为我设计这个结构的主要目的是为了简化代码。

在探寻spring的异常处理机制的时候，我分别使用了三种方式。三种方式都是使用的@ExceptionHandler注解。
当一个Controller中有方法加了@ExceptionHandler之后，这个Controller其他方法中没有捕获的异常就会以参数的形式传入加了@ExceptionHandler注解的那个方法中。
首先需要为自己的系统设计一个自定义的异常类，通过它来传递状态码。

/** * Created by liuruijie.
 * 自定义异常
 */
public class SystemException extends RuntimeException{
    private String code;//状态码
    public SystemException(String message, String code) {
        super(message);
        this.code = code;
    }
    public String getCode() {
        return code;
    }
}

第一种思路，设计一个基类。

/**
 * Created by liuruijie.
 * 处理异常的类，需要处理异常的Controller直接继承这个类
 */
public class BaseController {
    /**
     * 处理Controller抛出的异常
     * @param e 异常实例
     * @return Controller层的返回值
     */
    @ExceptionHandler
    @ResponseBody
    public Object expHandler(Exception e){
        if(e instanceof SystemException){
            SystemException ex= (SystemException) e;
            return WebResult.buildResult().status(ex.getCode())
                            .msg(ex.getMessage());
        }else{
            e.printStackTrace();
            return WebResult.buildResult().status(Config.FAIL)
                            .msg("系统错误");
        }
    }
}

之后所有需要异常处理的Controller都继承这个类，从而获取到异常处理的方法。
虽然这种方式可以解决问题，但是极其不灵活，因为动用了继承机制就只为获取一个默认的方法，这显然是不好的。

第二种思路，将这个基类变为接口，提供此方法的默认实现（也就是接口中的default方法，java8开始支持接口方法的默认实现）

/**
 * Created by liuruijie.
 * 接口形式的异常处理
 */
public interface DataExceptionSolver {
    @ExceptionHandler
    @ResponseBody
    default Object exceptionHandler(Exception e){
        try {
            throw e;
        } catch (SystemException systemException) {
            systemException.printStackTrace();
            return WebResult.buildResult().status(systemException.getCode())
                    .msg(systemException.getMessage());
        } catch (Exception e1){
            e1.printStackTrace();
            return WebResult.buildResult().status(Config.FAIL)
                    .msg("系统错误");
        }
    }
}

这种方式虽然没有占用继承，但是也不是很优雅，因为几乎所有的Controller都需要进行异常处理，于是我每个Controller都需要去写implement DataExceptionSolver，这显然不是我真正想要的。况且这种方式依赖java8才有的语法，这是一个很大的局限。

第三种思路，使用加强Controller做全局异常处理。

所谓加强Controller就是@ControllerAdvice注解，有这个注解的类中的方法的某些注解会应用到所有的Controller里，其中就包括@ExceptionHandler注解。
于是可以写一个全局的异常处理类：

/**
 * Created by liuruijie on 2016/12/28.
 * 全局异常处理，捕获所有Controller中抛出的异常。
 */
@ControllerAdvice
public class GlobalExceptionHandler {
   //处理自定义的异常
   @ExceptionHandler(SystemException.class) 
   @ResponseBody
   public Object customHandler(SystemException e){
      e.printStackTrace();
      return WebResult.buildResult().status(e.getCode()).msg(e.getMessage());
   }
   //其他未处理的异常
   @ExceptionHandler(Exception.class)
   @ResponseBody
   public Object exceptionHandler(Exception e){
      e.printStackTrace();
      return WebResult.buildResult().status(Config.FAIL).msg("系统错误");
   }
}

这个类中只处理了两个异常，但是已经满足了大部分需要，如果还有需要特殊处理的地方，可以再加上处理的方法就行了。第三种实现方式是目前我知道的最优雅的方式了。
如此，我们现在的Controller中的方法就可以很简洁了，比如处理登陆的逻辑就可以这样简单的写：

/**
 * Created by liuruijie on 2016/12/28.
 * 账号
 */
@RestController
@RequestMapping("passport")
public class PassportController {
    PassportService passportService;
        @RequestMapping("login")
    public Object doLogin(HttpSession session, String username, String password){
        User user = passportService.doLogin(username, password);
        session.setAttribute("user", user);
        return WebResult.buildResult().redirectUrl("/student/index");
    }
}

而在passprotService的doLogin方法中，可能会抛出用户名或密码错误等异常，然后就会交由GlobalExceptionHandler去处理，直接返回异常信息给前端，然后前端也不需要关心是否返回了异常，因为这些都已经定义好了。
前端js代码只需要这样写：

//登陆
AJAX.POST("/passport/login", {
    username:name,
    password:psw
})

一个异常在其中流转的过程为：
比如doLogin方法抛出了自定义异常，其code为：FAIL，message为：用户名或密码错误，由于在controller的方法中没有捕获这个异常，所以会将异常抛给GlobalExceptionHandler，然后GlobalExceptionHandler通过WebResult将状态码和提示信息返回给前端，前端通过默认的处理函数，弹框提示用户“用户名或密码错误”。而对于这样的一次交互，我们根本不用编写异常处理部分的逻辑。

到这里，代码已经简洁了很多，而且重用性大大提高。