Spring中的註解總結與簡單應用介紹-java教程-PHP中文網

這篇文章帶給大家的內容是關於Spring中的註解總結和簡單應用介紹，有一定的參考價值，有需要的朋友可以參考一下，希望對你有所幫助。

1. @Controller

標識一個該類別是Spring MVC controller處理器，用來建立處理http請求的物件.

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

登入後複製

2. @RestController

Spring4之後加入的註解，原來在@Controller中回傳json需要@ResponseBody來配合，如果直接用@RestController取代@Controller就不需要再配置@ResponseBody，預設回傳json格式。

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

登入後複製

3. @Service

用於標註業務層元件，說白了就是加入你有一個用註解的方式把這個類別注入到spring配置中

4 . @Autowired

用來組裝bean，都可以寫在欄位上，或是方法上。
預設情況下必須要求依賴物件必須存在，如果要允許null值，可以設定它的required屬性為false，例如：@Autowired(required=false)

5. @RequestMapping

#類別定義處: 提供初步的請求映射訊息，相對於WEB 應用的根目錄。
方法處: 提供進一步的細分映射信息，相對於類別定義處的 URL。

用過RequestMapping的同學都知道，他有非常多的作用，因此詳細的用法
我會在下一篇文章專門講述，請關注公眾號哦，以免錯過。

6. @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的參數名稱

7. @ModelAttribute

使用地方有三種：

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物件中，便於使用。

8. @Cacheable

用來標記快取查詢。可用用於方法或類別中，

當標記在一個方法上時表示該方法是支援快取的，

當標記在一個類別上時則表示該類別所有的方法都是支援緩存的。

參數清單

參數解釋範例##valuename@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}

登入後複製

9. @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)

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装配顺序:
如果同时指定了name和type，则从Spring上下文中找到唯一匹配的bean进行装配，找不到则抛出异常

如果指定了name，则从上下文中查找名称（id）匹配的bean进行装配，找不到则抛出异常

如果指定了type，则从上下文中找到类型匹配的唯一bean进行装配，找不到或者找到多个，都会抛出异常

如果既没有指定name，又没有指定type，则自动按照byName方式进行装配；如果没有匹配，则回退为一个原始类型进行匹配，如果匹配则自动装配；

11. @PostConstruct

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

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

12. @PreDestroy

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

13. @Repository

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

14. @Component

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

15. @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实例。

16. @SessionAttributes

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

参数：

names：这是一个字符串数组。里面应写需要存储到session中数据的名称。
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}

登入後複製