Spring中注解大全和应用

时间  2019-11-08
标签 spring 注解 大全 应用 栏目 Spring 繁體版
原文   原文链接
  1. @Controller
  2. @RestController：
  3. @Service
  4. @Autowired
  5. @RequestMapping
  6. @RequestParam
  7. @ModelAttribute
  8. @Cacheable
  9. @CacheEvict
  10. @Resource
  11. @PostConstruct
  12. @PreDestroy
  13. @Repository
  14. @Component
  15. @Scope
  16. @SessionAttributes
  17. @Required
  18. @Qualifier

@Controller

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

1@Controller
2public class TestController {
3        @RequestMapping("/test")
4        public String test(Map<String,Object> map){
5
6            return "hello";
7        }
8}
复制代码

@RestController

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

1@RestController
2public class TestController {
3        @RequestMapping("/test")
4        public String test(Map<String,Object> map){
5
6            return "hello";
7        }
8}
复制代码

@Service

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

@Autowired

用来装配bean，均可以写在字段上，或者方法上。
默认状况下必需要求依赖对象必须存在，若是要容许null值，能够设置它的required属性为false，例如：@Autowired(required=false) json

@RequestMapping

类定义处: 提供初步的请求映射信息，相对于 WEB 应用的根目录。
方法处: 提供进一步的细分映射信息，相对于类定义处的 URL。api

用过RequestMapping的同窗都知道，他有很是多的做用，所以详细的用法
我会在下一篇文章专门讲述，请关注公众号哦，以避免错过。数组

@RequestParam

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

1public Resp test(@RequestParam Integer id){
2        return Resp.success(customerInfoService.fetch(id));
3    }
复制代码

这个id就是要接收从接口传递过来的参数id的值的，若是接口传递过来的参数名和你接收的不一致，也能够以下缓存

1public Resp test(@RequestParam(value="course_id") Integer id){
2        return Resp.success(customerInfoService.fetch(id));
3    }
复制代码

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

@ModelAttribute

使用地方有三种：session

1. 标记在方法上。

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

A.在有返回的方法上:

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

1@ModelAttribute(value="user_name")
2    public String before2(@RequestParam(required = false) String name, Model model) {
3        System.out.println("进入了2：" + name);
4        return name;
5    }
复制代码
B.在没返回的方法上：

须要手动model.add方法

1    @ModelAttribute
2    public void before(@RequestParam(required = false) Integer age, Model model) {
3        model.addAttribute("age", age);
4        System.out.println("进入了1：" + age);
5    }
复制代码

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

 1@RequestMapping(value="/mod")
 2    public Resp mod(
 3            @RequestParam(required = false) String name,
 4            @RequestParam(required = false) Integer age, 
 5            Model model){
 6        System.out.println("进入mod");
 7        System.out.println("参数接受的数值{name="+name+";age="+age+"}");
 8        System.out.println("model传过来的值:"+model);
 9        return Resp.success("1");
10    }
复制代码

在浏览器中输入访问地址而且加上参数：
http://localhost:8081/api/test/mod?name=我是小菜&age=12

最终输出以下：

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

2. 标记在方法的参数上。

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

 1@RequestMapping(value="/mod2")
 2    public Resp mod2(@ModelAttribute("user_name") String user_name, 
 3            @ModelAttribute("name") String name,
 4            @ModelAttribute("age") Integer age,Model model){
 5        System.out.println("进入mod2");
 6        System.out.println("user_name:"+user_name);
 7        System.out.println("name："+name);
 8        System.out.println("age:"+age);
 9        System.out.println("model:"+model);
10        return Resp.success("1");
11    }
复制代码

在浏览器中输入访问地址而且加上参数：
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

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

当标记在一个方法上时表示该方法是支持缓存的，
当标记在一个类上时则表示该类全部的方法都是支持缓存的。

参数列表

参数 解释 例子
value 名称 @Cacheable(value={”c1”,”c2”}
key key @Cacheable(value=”c1”,key=”#id”)
condition 条件 @Cacheable(value=”c1”,condition=”#id=1”)

好比@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”)

参数列表

参数 解释 例子
value 名称 @CachEvict(value={”c1”,”c2”}
key key @CachEvict(value=”c1”,key=”#id”)
condition 缓存的条件，能够为空
allEntries 是否清空全部缓存内容 @CachEvict(value=”c1”，allEntries=true)
beforeInvocation 是否在方法执行前就清空 @CachEvict(value=”c1”，beforeInvocation=true)

@Resource

@Resource的做用至关于@Autowired
只不过@Autowired按byType自动注入，
而@Resource默认按 byName自动注入罢了。

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

@Resource装配顺序:

  1. 若是同时指定了name和type，则从Spring上下文中找到惟一匹配的bean进行装配，找不到则抛出异常
  2. 若是指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常
  3. 若是指定了type，则从上下文中找到类型匹配的惟一bean进行装配，找不到或者找到多个，都会抛出异常
  4. 若是既没有指定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 的做用域。
默认值是单例

  1. singleton:单例模式,全局有且仅有一个实例

  2. prototype:原型模式,每次获取Bean的时候会有一个新的实例

  3. request:request表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP request内有效

  4. session:session做用域表示该针对每一次HTTP请求都会产生一个新的bean，同时该bean仅在当前HTTP session内有效

  5. global session:只在portal应用中有用，给每个 global http session 新建一个Bean实例。

@SessionAttributes

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

参数：

  1. names：这是一个字符串数组。里面应写须要存储到session中数据的名称。
  2. types：根据指定参数的类型，将模型中对应类型的参数存储到session中
    三、value：和names是同样的。
 1@Controller
 2@SessionAttributes(value={"names"},types={Integer.class})
 3public class ScopeService {
 4        @RequestMapping("/testSession")
 5        public String test(Map<String,Object> map){
 6            map.put("names", Arrays.asList("a","b","c"));
 7            map.put("age", 12);
 8            return "hello";
 9        }
10}
复制代码

@Required

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

@Qualifier

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

以为本文对你有帮助？请分享给更多人
关注「编程无界」，提高装逼技能

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程