SpringBoot常用注解解释

SpringBoot注解解释

@RequestParam

作用：

用于将请求参数区数据映射到功能处理方法的参数上。

参数：

value：参数名字，即入参的请求参数名字，如username表示请求的参数区中的名字为username的参数的值将传入；
required：默认是true，表示请求中一定要有相应的参数，否则将报404错误码；
defaultValue：默认值，表示如果请求中没有同名参数时的默认值，默认值可以是SpEL表达式，如“#{systemProperties[‘java.vm.version’]}”。

举例：

@RequestMapping(value="/users")  
public String test(@PathVariable() int userId)  {
    return userId;
}

@ResponseBody

作用：

是将java对象转为json格式的数据。
是将controller的方法返回的对象通过适当的转换器转换为指定的格式之后，写入到response对象的body区，通常用来返回JSON数据或者是XML数据。
注意：在使用此注解之后不会再走视图处理器，而是直接将数据写入到输入流中，他的效果等同于通过response对象输出指定格式的数据。
作用在方法上时：@ResponseBody 表示该方法的返回结果直接写入 HTTP response body 中，一般在异步获取数据时使用【也就是AJAX】。
注意：在使用 @RequestMapping后，返回值通常解析为跳转路径，但是加上 @ResponseBody 后返回结果不会被解析为跳转路径，而是直接写入 HTTP response body 中。比如异步获取 json 数据，加上 @ResponseBody 后，会直接返回 json 数据。@RequestBody 将 HTTP 请求正文插入方法中，使用适合的 HttpMessageConverter 将请求体写入某个对象。
**作用在参数上时：**用于将前台发送过来固定格式的数据【xml格式或者 json等】封装为对应的 JavaBean 对象，
封装时使用到的一个对象是系统默认配置的 HttpMessageConverter进行解析，然后封装到形参上。

参数：无参

举例：

@RequestMapping("/login.do")
@ResponseBody
public Object login(String name, String password, HttpSession session) {
	user = userService.checkLogin(name, password);
	session.setAttribute("user", user);
	return new JsonResult(user);
}
 
@RequestMapping("/login.do")
public Object login(@RequestBody User loginUuser, HttpSession session) {
	user = userService.checkLogin(loginUser);
	session.setAttribute("user", user);
	return new JsonResult(user);
}

@PathVariable

作用：

是spring3.0的一个新功能：接收请求路径中占位符的值

参数：

无参(必须存在占位符中的参数名)

举例：

@RequestMapping("login/{id}/{name}")
public ModelAndView test5(@PathVariable("id") int id ,@PathVariable("name") String name){
    ModelAndView mv = new ModelAndView();
    return mv;
}

@ConditionalOnMissingBean

作用：

仅当 BeanFactory 中不包含指定的 bean class 和/或 name 时条件匹配该条件只能匹配到目前为止 application context 已经处理的 bean 定义，因此强烈建议仅在自动配置类上使用此条件。

参数：

prefix：表示配置文件里的节点前缀
name：name用来从application.properties中读取某个属性值
havingValue：表示目标值

举例：

@Bean
    @ConditionalOnMissingBean(name ="redisTemplate")
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        RedisTemplate<Object, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

@Primary

作用：

对同一个接口，可能会有几种不同的实现类，而默认只会采取@Primary标记一种。

参数：

无参

举例：

@Configuration
public class myConfigure {
 
    @Bean
    public MyTest createBean1(){
        return new MyTest();
    }
 
    @Bean
    @Primary
    public MyTest createBean2(){
        return new MyTest();
    }
}