Spring Boot中的注解

1、Bean相关注解

用于依赖注入：

Bean注入：@Autowired、@Resource。都可用于Bean注入，区别：

• @Resource和@Autowired都可以用来装配bean，都可以用于字段或setter方法。
• @Autowired默认按类型装配，默认情况下必须要求依赖对象必须存在，如果要允许null值，可以设置它的required属性为false。
• @Resource默认按名称装配，当找不到与名称匹配的bean时才按照类型进行装配。名称可以通过name属性指定，如果没有指定name属性，当注解写在字段上时，默认取字段名，当注解写在setter方法上时，默认取属性名进行装配。

注意：如果name属性一旦指定，就只会按照名称进行装配。

• @Autowire和@Qualifier配合使用效果和@Resource一样：

@Autowired(required = false) @Qualifier("example")
private Example example;

@Resource(name = "example")
private Example example;

@Resource装配顺序:

1. 如果同时指定name和type，则从容器中查找唯一匹配的bean装配，找不到则抛出异常

2. 如果指定name属性，则从容器中查找名称匹配的bean装配，找不到则抛出异常

3. 如果指定type属性，则从容器中查找类型唯一匹配的bean装配，找不到或者找到多个抛出异常

4. 如果都不指定，则自动按照byName方式装配，如果没有匹配，则回退一个原始类型进行匹配，如果匹配则自动装配

注解对比	@Resource	@Autowire
注解来源	JDK	Spring
装配方式	优先按名称	优先按类型
属性	name、type	required

配置文件中的参数注入到java变量：@Value

'@Autowired'和'@Inject'注释的行为相同。这两个注释都使用'AutowiredAnnotationBeanPostProcessor'注入依赖项。'@Autowired'和'@Inject'可以互换使用来注入Spring bean。但是，“ @ Resource”注释使用“ CommonAnnotationBeanPostProcessor”来注入依赖项。即使它们使用不同的后处理器类，它们的行为也几乎相同。以下是其执行路径的摘要。

用于Bean定义：（根据被Spring容器发现的方式可分为两类）

自动扫描：@Component（@Controller、@Service、@Repository，三者与@Component等效，只不过在语义上更明确）：用在类上，声明此类是个Bean，会被Spring ComponentScan扫描并由Spring容器自动创建实例并注册

手动配置：@Configuration+@Bean：前者用在类上、后者用在@Configuration修饰的类内的方法上，效果相当于xml中的beans与bean的关系；实例需要用户在@Bean修饰的方法中手动创建返回，Spring容器通过@Configuration扫描并注册其所修饰的类内的Bean

@Component

@Component是所有受Spring 管理组件的通用形式，@Component注解可以放在类的头上，@Component不推荐使用。

@Controller

@Controller对应表现层的Bean，也就是Action，例如：

@Controller
@Scope("prototype")
public class UserAction extends BaseAction{
    ……
}

使用@Controller注解标识UserAction之后，就表示要把UserAction交给Spring容器管理，在Spring容器中会存在一个名字为"userAction"的action，这个名字是根据UserAction类名来取的。

注意：如果@Controller不指定其value【@Controller】，则默认的bean名字为这个类的类名首字母小写，如果指定value【@Controller(value="UserAction")】或者【@Controller("UserAction")】，则使用value作为bean的名字。

这里的UserAction还使用了@Scope注解，@Scope("prototype")表示将Action的范围声明为原型，可以利用容器的scope="prototype"来保证每一个请求有一个单独的Action来处理，避免struts中Action的线程安全问题。spring 默认scope是单例模式(scope="singleton")，这样只会创建一个Action对象，每次访问都是同一Action对象，数据不安全，struts2 是要求每次次访问都对应不同的Action，scope="prototype" 可以保证当有请求的时候都创建一个Action对象。

@Service

@Service对应的是业务层Bean，例如：

@Service("userService")
public class UserServiceImpl implements UserService {
    ………
}

@Service("userService")注解是告诉Spring，当Spring要创建UserServiceImpl的的实例时，bean的名字必须叫做"userService"，这样当Action需要使用UserServiceImpl的的实例时,就可以由Spring创建好的"userService"，然后注入给Action：在Action只需要声明一个名字叫“userService”的变量来接收由Spring注入的"userService"即可，具体代码如下：

// 注入userService
@Resource(name = "userService")
private UserService userService;

注意：在Action声明的“userService”变量的类型必须是“UserServiceImpl”或者是其父类“UserService”，否则由于类型不一致而无法注入，由于Action中的声明的“userService”变量使用了@Resource注解去标注，并且指明了其name = "userService"，这就等于告诉Spring，说我Action要实例化一个“userService”，你Spring快点帮我实例化好，然后给我，当Spring看到userService变量上的@Resource的注解时，根据其指明的name属性可以知道，Action中需要用到一个UserServiceImpl的实例，此时Spring就会把自己创建好的名字叫做"userService"的UserServiceImpl的实例注入给Action中的“userService”变量，帮助Action完成userService的实例化，这样在Action中就不用通过“UserService userService = new UserServiceImpl();”这种最原始的方式去实例化userService了。如果没有Spring，那么当Action需要使用UserServiceImpl时，必须通过“UserService userService = new UserServiceImpl();”主动去创建实例对象，但使用了Spring之后，Action要使用UserServiceImpl时，就不用主动去创建UserServiceImpl的实例了，创建UserServiceImpl实例已经交给Spring来做了，Spring把创建好的UserServiceImpl实例给Action，Action拿到就可以直接用了。Action由原来的主动创建UserServiceImpl实例后就可以马上使用，变成了被动等待由Spring创建好UserServiceImpl实例之后再注入给Action，Action才能够使用。这说明Action对“UserServiceImpl”类的“控制权”已经被“反转”了，原来主动权在自己手上，自己要使用“UserServiceImpl”类的实例，自己主动去new一个出来马上就可以使用了，但现在自己不能主动去new“UserServiceImpl”类的实例，new“UserServiceImpl”类的实例的权力已经被Spring拿走了，只有Spring才能够new“UserServiceImpl”类的实例，而Action只能等Spring创建好“UserServiceImpl”类的实例后，再“恳求”Spring把创建好的“UserServiceImpl”类的实例给他，这样他才能够使用“UserServiceImpl”，这就是Spring核心思想“控制反转”，也叫“依赖注入”，“依赖注入”也很好理解，Action需要使用UserServiceImpl干活，那么就是对UserServiceImpl产生了依赖，Spring把Acion需要依赖的UserServiceImpl注入(也就是“给”)给Action，这就是所谓的“依赖注入”。对Action而言，Action依赖什么东西，就请求Spring注入给他，对Spring而言，Action需要什么，Spring就主动注入给他。

@Repository

@Repository对应数据访问层Bean ，例如

@Repository(value="userDao")
public class UserDaoImpl extends BaseDaoImpl {
    ………
}

@Repository(value="userDao")注解是告诉Spring，让Spring创建一个名字叫“userDao”的UserDaoImpl实例。

当Service需要使用Spring创建的名字叫“userDao”的UserDaoImpl实例时，就可以使用@Resource(name = "userDao")注解告诉Spring，Spring把创建好的userDao注入给Service即可。

// 注入userDao，从数据库中根据用户Id取出指定用户时需要用到
@Resource(name = "userDao")
private BaseDao userDao;

@Scope

标记在类和方法，标记上述Spring Bean的作用域：singleton、prototype、request、session、application、websocket

• singleton：单例，无论getBean多少次得到的都是同一个实例。默认值为此，如@Service、@Repository、@Component等的scope
• prototype：每次getBean都创建一个新的实例。从某方面来说，类似于new操作。
• request：每个http请求创建一个实例，该实例仅在该请求内有效且该请求过程中用同一个实例，不同request创建的实例互不干扰；实例随请求结束而销毁
• session：每当创建一个会话时创建一个实例，实例随着会话的结束而销毁
• application：在一个ServletContext lifecycle内公用一个实例。注：不是ApplicationContext lifecycle，一个ServletContext可能包含多个ApplicationContext

• websocket：在一个WebSocket lifecycle内公用一个实例

  
  

Java Singleton与Spring Singleton的区别：Java单例类是每个类加载器，Spring的单例是每个应用程序上下文。

2、接收请求请求

（1）使用HttpServletRequest获取，如request.getParameter("name")

@RequestMapping("/login.do")  
public String login(HttpServletRequest request){  
    String name = request.getParameter("name")  
    String pass = request.getParameter("pass")  
}  

（2）@RequestParam("pass")String password，或@Param("pass")String password。表单参数也可以用这种方式获取，Spring会自动将表单参数注入到方法参数，和表单的name属性保持一致。

@RequestMapping("/login.do")  
public String login(HttpServletRequest request,   @RequestParam("name") String name,  @RequestParam("pass") String password) // 表单属性是pass,用变量password接收  
{  
   System.out.println(name);  
   System.out.println(password)  
}  

（3）自动注入Bean属性

  
用户名：  
密码：  
  
  

//封装的User类  
public class User{  
  private String name;  
  private String pass;  
}  

@RequestMapping("/login.do")  
public String login(User user)  
{  
   System.out.println(user.getName());  
   System.out.println(user.getPass());  
}  

3、向页面传参

使用HttpServletRequest 和 Session 然后setAttribute()，就和Servlet中一样

使用ModelAndView对象

@RequestMapping("/login.do")  
public ModelAndView  login(String name,String pass){  
    User user = userService.login(name,pwd);  
    Map data = new HashMap();  
    data.put("user",user);  
    return new ModelAndView("success",data);  
}  

使用ModelMap对象

@RequestMapping("/login.do")  
public　String login(String name,String pass ,ModelMap model){  
    User user  = userService.login(name,pwd);  
    model.addAttribute("user",user);  
    model.put("name",name);  
    return "success";  
}  

使用@ModelAttribute注解

在Controller方法的参数部分或Bean属性方法上使用

@RequestMapping("/login.do")  
public String login(@ModelAttribute("user") User user){  
    //TODO  
   return "success";  
}  
  
@ModelAttribute("name")  
public String getName(){  
    return name;  
}  

Session存储

可以利用HttpServletReequest的getSession()方法

@RequestMapping("/login.do")  
public String login(String name,String pwd, ModelMap model,HttpServletRequest request){  
     User user = serService.login(name,pwd);  
     HttpSession session = request.getSession();  
     session.setAttribute("user",user);  
     model.addAttribute("user",user);  
     return "success";  
}  

4、异常捕获处理

@ExceptionHandler：捕获特定异常进行处理，仅对当前Controller有效

@ControllerAdvice：修饰类，捕获全局各个Controller抛出的异常。ControllerAdvice注解只拦截Controller不会拦截Interceptor的异常。

示例：

@Controller
@RequestMapping("/exception")
@ControllerAdvice
public class ExceptionController {
    @ExceptionHandler({ ArithmeticException.class }) // 单用@ExceptionHandler时只对当前controller有效即只捕获当前Controller抛出的异常，结合@ControllerAdvice可对全局有效。
    // @ResponseStatus(value = HttpStatus.NOT_FOUND)
    @ResponseBody
    public String handleArithmeticException(Exception e) {
        e.printStackTrace();
        return "some arighmetric error";
    }

    @RequestMapping(value = "e/{id}", method = { RequestMethod.GET })
    @ResponseBody
    public String testExceptionHandle(@PathVariable(value = "id") Integer id) {
        System.out.println(10 / id);
        return id.toString();
    }
}

@Controller
class TTT {
    @RequestMapping(value = "e/{id}", method = { RequestMethod.GET })
    @ResponseBody
    public String testExceptionHandle(@PathVariable(value = "id") Integer id) {
        System.out.println(10 / id);
        return id.toString();
    }
}

该示例中，若没有@ControllerAdvice注解，则分别访问 http://localhost:8081/exception/e/0 、 http://localhost:8081/e/0 前者会被@ExceptionController指定的方法捕获处理、后者则不会被捕获。若加上@ControllerAdvice注解则访问两个路径都会被处理。另外注意，类需要在能被spring扫描到的包下。

5、request body传数组

public Integer deleteAdminAnStus(@RequestBody List studentIdList, HttpServletRequest request) {
}   // 前端请求时直接在body传类似如下格式的数据即可：  ["a","b"]

6、页面重定向

假设当前在 /api/v1，则

response.sendRedirect("/test"); 将导向 /test

response.sendRedirect("test"); 将导向 /api/test

7、手动返回错误信息

response.sendError(400, "some error");

8、返回数据的统一包装

@ControllerAdvice // 拦截所有Controller的处理结果
public class ControllerResponseWrapper implements ResponseBodyAdvice