Spring|SpringMVC中的注解

文章目录

• 一、Spring注解
• @Controller
• @ResuController
• @Service
• @Autowired
• @RequestMapping
• @RequestParam
• @ModelAttribute
• @Cacheable
• @CacheEvict
• @Resource
• @PostConstruct
• @PreDestroy
• @Repository
• @Conponent
• @Scope
• @SessionAttributes
• @Requireds
• @Qualifier
• Spring声明bean的注解
• Spring注入bean的注解
• Spring中java配置类相关注解
• Spring切面（AOP）相关注解
• Spring中@Bean的属性支持
• @Value注解
• 环境切换
• 异步相关
• 定时任务相关
• @Enable*注解说明
• 测试相关注解
• 二、SpringMVC注解（11个）

---

一、Spring注解

@Controller

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

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

@ResuController

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

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

@Service

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

@Autowired

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

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

@RequestMapping

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

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

@RequestParam

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

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

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

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

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

@ModelAttribute

使用地方有三种：

##1.标记在方法上

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

A：在有返回的方法上:

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

@ModelAttribute
public String before2(@RequestParam(required = false)String name,Model model){
	sout("测试:"+name);
	return name;
}

B：在没有返回的方法上。

需要手动model.add方法。

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

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

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

@RequestMapping(value="/mod2")
public Resp mod(@ModelAttribute("user_name")String user_name,
				@ModelAttribute("name")String name,Model model){

}

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

@Cacheable

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

当标记在一个方法上时表示该方法是支持缓存的，

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

参数列表：

比如@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;
}

@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装配顺序：

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组件。

@Conponent

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

@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中。
3. value：和names是一样的。

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

@Requireds

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

@Qualifier

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

---

Spring声明bean的注解

• @Component 组件，没有明确的角色
• @Service 在业务逻辑层使用（service层）
• @Repository 在数据访问层使用（dao层）
• @Controller 在展现层使用，控制器的声明（C）

Spring注入bean的注解

• @Autowired：由Spring提供
• @Inject：由JSR-330提供
• @Resource：由JSR-250提供

Spring中java配置类相关注解

• @Configuration 声明当前类为配置类，相当于xml形式的Spring配置（类上）
• @Bean 注解在方法上，声明当前方法的返回值为一个bean，替代xml中的方式（方法上）
• @Configuration 声明当前类为配置类，其中内部组合了@Component注解，表明这个类是一个bean（类上）
• @ComponentScan 用于对Component进行扫描，相当于xml中的（类上）
• @WishlyConfiguration 为@Configuration与@ComponentScan的组合注解，可以替代这两个注解

Spring切面（AOP）相关注解

Spring支持AspectJ的注解式切面编程。

• @Aspect 声明一个切面（类上。使用@After、@Before、@Around定义建言（advice），可直接将拦截规则（切点）作为参数。
• @After 在方法执行之后执行（方法上）
• @Before 在方法执行之前执行（方法上）
• @Around 在方法执行之前与之后执行（方法上）
• @PointCut 声明切点。在java配置类中使用@EnableAspectJAutoProxy注解开启Spring对AspectJ代理的支持（类上）

Spring中@Bean的属性支持

• @Scope 设置Spring容器如何新建Bean实例（方法上，得有@Bean）。其设置类型包括：
• Singleton （单例,一个Spring容器中只有一个bean实例，默认模式）,
• Protetype （每次调用新建一个bean）
• Request （web项目中，给每个http request新建一个bean）,
• Session （web项目中，给每个http session新建一个bean）,
• GlobalSession（给每一个 global http session新建一个Bean实例）
• @StepScope 在Spring Batch中还有涉及
• @PostConstruct 由JSR-250提供，在构造函数执行完之后执行，等价于xml配置文件中bean的initMethod
• @PreDestory 由JSR-250提供，在Bean销毁之前执行，等价于xml配置文件中bean的destroyMethod

@Value注解

@Value 为属性注入值（属性上）

• 注入普通字符

@Value("Michael Jackson")
String name;

• 注入操作系统属性

@Value("#{systemProperties['os.name']}")
String osName;

• 注入表达式结果

@Value("#{ T(java.lang.Math).random() * 100 }")
String randomNumber;

• 注入其它bean属性

@Value("#{domeClass.name}")
String name;

• 注入文件资源

@Value("classpath:com/hgs/hello/test.txt")
String Resource file;

• 注入网站资源

@Value("http://www.cznovel.com")
Resource url;12

• 注入配置文件

@Value("${book.name}")
String bookName;

• 注入配置使用方法：
  
  编写配置文件（test.properties）

book.name=《测试》

@PropertySource 加载配置文件(类上)

@PropertySource("classpath:com/hgs/hello/test/test.propertie")

还需配置一个PropertySourcesPlaceholderConfigurer的bean。

环境切换

• @Profile 通过设定Environment的ActiveProfiles来设定当前context需要使用的配置环境。（类或方法上）
• @Conditional Spring4中可以使用此注解定义条件话的bean，通过实现Condition接口，并重写matches方法，从而决定该bean是否被实例化。（方法上）

异步相关

• @EnableAsync 配置类中，通过此注解开启对异步任务的支持，叙事性AsyncConfigurer接口（类上）
• @Async 在实际执行的bean方法使用该注解来申明其是一个异步任务（方法上或类上所有的方法都将异步，需要@EnableAsync开启异步任务）

定时任务相关

• @EnableScheduling 在配置类上使用，开启计划任务的支持（类上）
• @Scheduled 来申明这是一个任务，包括cron,fixDelay,fixRate等类型（方法上，需先开启计划任务的支持）

@Enable*注解说明

这些注解主要用来开启对xxx的支持。

• @EnableAspectJAutoProxy 开启对AspectJ自动代理的支持
• @EnableAsync 开启异步方法的支持
• @EnableScheduling 开启计划任务的支持
• @EnableWebMvc 开启Web MVC的配置支持
• @EnableConfigurationProperties 开启对@ConfigurationProperties注解配置Bean的支持
• @EnableJpaRepositories 开启对SpringData JPA Repository的支持
• @EnableTransactionManagement 开启注解式事务的支持
• @EnableTransactionManagement 开启注解式事务的支持
• @EnableCaching 开启注解式的缓存支持

测试相关注解

• @RunWith 运行器，Spring中通常用于对JUnit的支持

@RunWith(SpringJUnit4ClassRunner.class)1

• @ContextConfiguration 用来加载配置ApplicationContext，其中classes属性用来加载配置类

@ContextConfiguration(classes={TestConfig.class})

二、SpringMVC注解（11个）

• @EnableWebMvc 在配置类中开启Web MVC的配置支持，如一些ViewResolver或者MessageConverter等，若无此句，重写WebMvcConfigurerAdapter方法（用于对SpringMVC的配置）。
• @Controller 声明该类为SpringMVC中的Controller
• @RequestMapping 用于映射Web请求，包括访问路径和参数（类或方法上）
• @ResponseBody 支持将返回值放在response内，而不是一个页面，通常用户返回json数据（返回值旁或方法上）
• @RequestBody 允许request的参数在request体中，而不是在直接连接在地址后面。（放在参数前）
• @PathVariable 用于接收路径参数，比如@RequestMapping(“/hello/{name}”)申明的路径，将注解放在参数中前，即可获取该值，通常作为Restful的接口实现方法。
• @RestController 该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
• @ControllerAdvice 通过该注解，我们可以将对于控制器的全局配置放置在同一个位置，注解了@Controller的类的方法可使用@ExceptionHandler、@InitBinder、@ModelAttribute注解到方法上，这对所有注解了 @RequestMapping的控制器内的方法有效。
• @ExceptionHandler 用于全局处理控制器里的异常
• @InitBinder 用来设置WebDataBinder，WebDataBinder用来自动绑定前台请求参数到Model中。
• @ModelAttribute 本来的作用是绑定键值对到Model里，在@ControllerAdvice中是让全局的@RequestMapping都能获得在此处设置的键值对。