Spring:概述Spring中常用的注解

Spring:概述Spring中常用的注解


1 . @Controller

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

@Controller
public class TestController {
	@RequestMapping("/test")
	public String test(){
		return "hello";
	}
}

2 . @RestController

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

@Controller
public class TestController {
	@RequestMapping("/test")
	public @ResponseBody String test(){
		return "hello";
	}
}

@RestController
public class TestController {
	@RequestMapping("/test")
	public String test(){
		return "hello";
	}
}

3 . @Service

      用于标注业务层组件,即用注解的方式将一个业务层的类注入到spring配置中。

4 . @Autowired

      用来装配bean,可以写在字段上,或者方法上。默认情况下要求依赖对象必须存在。如果要允许null值,可以设置它的required属性为false,例如:@Autowired(required=false)。

5 . @RequestMapping

      用在类定义处: 提供初步的请求映射信息;
      用在具体方法处: 提供进一步的细分映射信息。

6 . @RequestParam

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

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

      这个id就是要接收从接口传递过来的参数id的值的,如果接口传递过来的参数名和你接收的不一致,可以用@RequestParam的value属性进行设置,如下:

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

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

7 . @ModelAttribute

      使用地方有三种:

      (1) 标记在方法上:标记在方法上,会在每一个@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 before(@RequestParam(required = false) String name, Model model) {
	return name;
}

      B.在没返回值的方法上:
      需要手动model.add方法

@ModelAttribute
public void before(@RequestParam(required = false) Integer age, Model model) {
	model.addAttribute("age", age);
}

      (2) 标记在方法的参数上。
      标记在方法的参数上,会将客户端传递过来的参数按名称注入到指定对象中,并且会将这个对象自动加入ModelMap中,便于View层使用。

8 . @Cacheable

      用来标记缓存查询。可用用于方法或者类中。
      当标记在一个方法上时,表示该方法是支持缓存的,
      当标记在一个类上时则,表示该类所有的方法都是支持缓存的。

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

      比如@Cacheable(value=“UserCache”) 标识的是当调用了标记了这个注解的方法时,会先从缓存中获取数据,如果缓存中没有数据,则执行用户编写查询逻辑,查询成功之后,同时将结果放入缓存中。
      但凡说到缓存,都是key-value的形式的,因此key就是方法中的参数(id),value就是查询的结果,而命名空间UserCache是在spring*.xml中定义。

@Cacheable(value="UserCache")
public Account getUserAge(int id) {  
	//这里不用写缓存的逻辑,直接按正常业务逻辑走即可,缓存通过切面自动切入  
	int age=getUser(id);   
	return age;   
} 

9 . @CacheEvict

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

参数解释例子
value名称@CachEvict(value={”c1”,”c2”}
keykey@CachEvict(value=”c1”,key=”#id”)
condition条件可以为空,
allEntries:是否清空所有缓存内容 @CachEvict(value=”c1”,allEntries=true);
beforeInvocation 是否在方法执行前就清空 @CachEvict(value=”c1”,beforeInvocation=true)

10 . @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方式进行装配;如果没有匹配,则回退为一个原始类型进行匹配,如果匹配则自动装配。

11 . @PostConstruct

      用来标记在项目启动的时候执行这个方法,即spring容器启动时就执行。用来修饰一个非静态的void()方法,多用于一些全局配置、数据字典之类的加载

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

12 . @PreDestroy

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

13 . @Repository

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

14 . @Component

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

15 . @Scope

      用来配置 spring bean 的作用域。默认值是单例,类型如下:

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

16 . @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";
	}
}

17 . @Required

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

18 . @Qualifier

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

参考:https://mp.weixin.qq.com/s/x8vST8RqogCJ_i11CvoFAw

©️2020 CSDN 皮肤主题: Age of Ai 设计师:meimeiellie 返回首页