Spring中的18个注解

jiezi

5 年前

@Controller

标识一个该类是 Spring MVC controller 处理器，用来创建处理 http 请求的对象.

@Controller
public class TestController {@RequestMapping("/test")
 public String test(Map<String,Object> map){return "hello";}
}

@RestController

Spring4 之后加入的注解，原来在 @Controller 中返回 json 需要 @ResponseBody 来配合，如果直接用 @RestController 替代 @Controller 就不需要再配置 @ResponseBody，默认返回 json 格式。

@RestController
public class TestController {@RequestMapping("/test")
 public String test(Map<String,Object> map){return "hello";}
}
@Service

@Service

用于标注业务层组件，说白了就是加入你有一个用注解的方式把这个类注入到 spring 配置中

@Autowired

用来装配 bean，都可以写在字段上，或者方法上。

默认情况下必须要求依赖对象必须存在，如果要允许 null 值，可以设置它的 required 属性为 false，例如：@Autowired(required=false)

@RequestMapping

类定义处: 提供初步的请求映射信息，相对于 WEB 应用的根目录。

方法处: 提供进一步的细分映射信息，相对于类定义处的 URL。

用过 RequestMapping 的同学都知道，他有非常多的作用，因此详细的用法

我会在下一篇文章专门讲述，请关注公众号哦，以免错过。

@RequestParam

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

例如

public Resp test(@RequestParam Integer id){return Resp.success(customerInfoService.fetch(id));
}

这个 id 就是要接收从接口传递过来的参数 id 的值的，如果接口传递过来的参数名和你接收的不一致，也可以如下

public Resp test(@RequestParam(value="course_id") Integer id){return Resp.success(customerInfoService.fetch(id));
 }

其中 course_id 就是接口传递的参数，id 就是映射 course_id 的参数名

@ModelAttribute

使用地方有三种：

标记在方法上。

标记在方法上，会在每一个 @RequestMapping 标注的方法前执行，如果有返回值，则自动将该返回值加入到 ModelMap 中。
A. 在有返回的方法上:

当 ModelAttribute 设置了 value，方法返回的值会以这个 value 为 key，以参数接受到的值作为 value，存入到 Model 中，如下面的方法执行之后，最终相当于 model.addAttribute(“user_name”, name); 假如 @ModelAttribute 没有自定义 value，则相当于

model.addAttribute(“name”, name);

@ModelAttribute(value="user_name")
 public String before2(@RequestParam(required = false) String name, Model model) {System.out.println("进入了 2：" + name);
 return name;
 }

B. 在没返回的方法上：

需要手动 model.add 方法

 @ModelAttribute
 public void before(@RequestParam(required = false) Integer age, Model model) {model.addAttribute("age", age);
 System.out.println("进入了 1：" + age);
 }

我们在当前类下建一个请求方法：

 @RequestMapping(value="/mod")
  public Resp mod(@RequestParam(required = false) String name,
  @RequestParam(required = false) Integer age, 
  Model model){System.out.println("进入 mod");
  System.out.println("参数接受的数值{name="+name+";age="+age+"}");
  System.out.println("model 传过来的值:"+model);
  return Resp.success("1");
 }

在浏览器中输入访问地址并且加上参数：

http://localhost:8081/api/test/mod?name= 我是小菜 &age=12

最终输出如下：

进入了 1：40
进入了 2：我是小菜
进入 mod
参数接受的数值{name= 我是小菜;age=12}
5model 传过来的值:{age=40, user_name= 我是小菜}

标记在方法的参数上。

标记在方法的参数上，会将客户端传递过来的参数按名称注入到指定对象中，并且会将这个对象自动加入 ModelMap 中，便于 View 层使用. 我们在上面的类中加入一个方法如下

@RequestMapping(value="/mod2")
 public Resp mod2(@ModelAttribute("user_name") String user_name, 
 @ModelAttribute("name") String name,
 @ModelAttribute("age") Integer age,Model model){System.out.println("进入 mod2");
System.out.println("user_name:"+user_name);
 System.out.println("name："+name);
 System.out.println("age:"+age);
 System.out.println("model:"+model);
 return Resp.success("1");
 }

在浏览器中输入访问地址并且加上参数：

http://localhost:8081/api/test/mod2?name= 我是小菜 &age=12

最终输出：

 1 进入了 1：40
2 进入了 2：我是小菜
3 进入 mod2
4user_name: 我是小菜
5name：我是小菜
6age:40
7model:{user_name= 我是小菜, org.springframework.validation.BindingResult.user_name=org.springframework.validation.BeanPropertyBindingResult: 0 errors, name= 我是小菜, org.springframework.validation.BindingResult.name=org.springframework.validation.BeanPropertyBindingResult: 0 errors, age=40, org.springframework.validation.BindingResult.age=org.springframework.validation.BeanPropertyBindingResult: 0 errors}

从结果就能看出，用在方法参数中的 @ModelAttribute 注解，实际上是一种接受参数并且自动放入 Model 对象中，便于使用。

@Cacheable

用来标记缓存查询。可用用于方法或者类中，

当标记在一个方法上时表示该方法是支持缓存的，当标记在一个类上时则表示该类所有的方法都是支持缓存的。
参数列表

比如 @Cacheable(value=”UserCache”) 标识的是当调用了标记了这个注解的方法时，逻辑默认加上从缓存中获取结果的逻辑，如果缓存中没有数据，则执行用户编写查询逻辑，查询成功之后，同时将结果放入缓存中。

但凡说到缓存，都是 key-value 的形式的，因此 key 就是方法中的参数（id），value 就是查询的结果，而命名空间 UserCache 是在 spring*.xml 中定义.

1@Cacheable(value="UserCache")// 使用了一个缓存名叫 accountCache 
2public Account getUserAge(int id) { 
3 // 这里不用写缓存的逻辑，直接按正常业务逻辑走即可，4 // 缓存通过切面自动切入 
5 int age=getUser(id); 
6 return age; 
7}

@CacheEvict

用来标记要清空缓存的方法，当这个方法被调用后，即会清空缓存。@CacheEvict(value=”UserCache”)

参数列表

@Resource

@Resource 的作用相当于 @Autowired

只不过 @Autowired 按 byType 自动注入，

而 @Resource 默认按 byName 自动注入罢了。

@Resource 有两个属性是比较重要的，分是 name 和 type，Spring 将 @Resource 注解的 name 属性解析为 bean 的名字，而 type 属性则解析为 bean 的类型。所以如果使用 name 属性，则使用 byName 的自动注入策略，而使用 type 属性时则使用 byType 自动注入策略。如果既不指定 name 也不指定 type 属性，这时将通过反射机制使用 byName 自动注入策略。

@Resource 装配顺序:

如果同时指定了 name 和 type，则从 Spring 上下文中找到唯一匹配的 bean 进行装配，找不到则抛出异常
如果指定了 name，则从上下文中查找名称（id）匹配的 bean 进行装配，找不到则抛出异常
如果指定了 type，则从上下文中找到类型匹配的唯一 bean 进行装配，找不到或者找到多个，都会抛出异常
如果既没有指定 name，又没有指定 type，则自动按照 byName 方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配；

@PostConstruct

用来标记是在项目启动的时候执行这个方法。用来修饰一个非静态的 void()方法

也就是 spring 容器启动时就执行，多用于一些全局配置、数据字典之类的加载

被 @PostConstruct 修饰的方法会在服务器加载 Servlet 的时候运行，并且只会被服务器执行一次。PostConstruct 在构造函数之后执行,init()方法之前执行。PreDestroy（）方法在 destroy()方法执行执行之后执

@PreDestroy

被 @PreDestroy 修饰的方法会在服务器卸载 Servlet 的时候运行，并且只会被服务器调用一次，类似于 Servlet 的 destroy()方法。被 @PreDestroy 修饰的方法会在 destroy()方法之后运行，在 Servlet 被彻底卸载之前

@Repository

用于标注数据访问组件，即 DAO 组件

@Component

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

@Scope

用来配置 spring bean 的作用域，它标识 bean 的作用域。

默认值是单例

singleton: 单例模式, 全局有且仅有一个实例
prototype: 原型模式, 每次获取 Bean 的时候会有一个新的实例
request:request 表示该针对每一次 HTTP 请求都会产生一个新的 bean，同时该 bean 仅在当前 HTTP request 内有效
session:session 作用域表示该针对每一次 HTTP 请求都会产生一个新的 bean，同时该 bean 仅在当前 HTTP session 内有效
global session: 只在 portal 应用中有用，给每一个 global http session 新建一个 Bean 实例。

@SessionAttributes

默认情况下 Spring MVC 将模型中的数据存储到 request 域中。当一个请求结束后，数据就失效了。如果要跨页面使用。那么需要使用到 session。而 @SessionAttributes 注解就可以使得模型中的数据存储一份到 session 域中

参数：

names：这是一个字符串数组。里面应写需要存储到 session 中数据的名称。
types：根据指定参数的类型，将模型中对应类型的参数存储到 session 中
value：和 names 是一样的。

@Controller
@SessionAttributes(value={"names"},types={Integer.class})
public class ScopeService {@RequestMapping("/testSession")
 public String test(Map<String,Object> map){map.put("names", Arrays.asList("a","b","c"));
 map.put("age", 12);
 return "hello";
 }
}

@Required

适用于 bean 属性 setter 方法，并表示受影响的 bean 属性必须在 XML 配置文件在配置时进行填充。否则，容器会抛出一个 BeanInitializationException 异常。

@Qualifier

当你创建多个具有相同类型的 bean 时，并且想要用一个属性只为它们其中的一个进行装配，在这种情况下，你可以使用 @Qualifier 注释和 @Autowired 注释通过指定哪一个真正的 bean 将会被装配来消除混乱。