總是說spring難學?來看完這些spring的註解及其解釋,真香

前言

用過spring的人都知道,spring簡單的通過註解就可以完成很多事情,但這些東西是如何實現的呢以及如何應用到我們自己的代碼中?接下來,讓我們一起開啟註解的旅程。

1. @Controller

標識一個該類是Spring MVC controller處理器,用來創建處理http請求的對象.

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

2. @Component、@Repository、@Service、@Controller作用等價相同的

區別:如果 Web 應用程序採用了經典的三層分層結構的話,最好在持久層、業務層和控制層分別採用 @Repository、@Service 和 @Controller 對分層中的類進行註釋,而用 @Component 對那些比較中立的類進行註釋。

用來裝配bean,主要用於標註業務層組件,通過註解的方式將該類加入到spring 中進行管理。

<code>@Service public interface UserService { User login(String username,String password); } //當把註解寫在接口上時,spring容器會注入失敗。 //註解寫在類上 注入不會失敗。 @Service public class UserServiceImpl implements UserService{ @Autowired private UserMapper userMapper; } @Controller @RequestMapping("user") public class UserController { @Autowired private UserService userService } /<code>

3. @Autowired

用來裝配bean,可以寫在字段上,也可以寫在方法上。
默認情況下必須要求依賴對象必須存在,如果要允許null值,可以設置它的required屬性為false,例如:@Autowired(required=false)

4. @RequestMapping

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


說白了,就是例如(“user”)網站上訪問localhost:8080/user.html就可以訪問這個方法和html頁面。

5. @RequestParam

用於將請求參數區數據映射到功能處理方法的參數上
例如:

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

這個id就是要接收從接口傳遞過來的參數id的值的,如果接口傳遞過來的參數名和你接收的不一致,也可以如下:

<code>public Resp test(@RequestParam(value="userId") Integer id){ return Resp.success(customerInfoService.fetch(id)); } /<code>

其中userId就是接口傳遞的參數,id就是映射userId的參數名。

6. @ModelAttribute

使用地方有三種:

標記在方法上。

標記在方法上,會在每一個@RequestMapping標註的方法前執行,如果有返回值,則自動>將該返回值加入到ModelMap中。

A.在有返回的方法上:
當ModelAttribute設置了value,方法返回的值會以這個value為key,以參數接受到的值作為value,存入到Model中,如下面的方法執行之後,最終相當於 model.addAttribute(“user_name”, name);假如 @ModelAttribute沒有自定義value,則相當於
model.addAttribute(“name”, name);

<code>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 } /<code>

B.在沒返回的方法上:
需要手動model.add方法

<code>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 } /<code>

我們在當前類下建一個請求方法:

<code> 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 } /<code>

在瀏覽器中輸入訪問地址並且加上參數:
http://localhost:8081/api/test/mod?name=我是小菜&age=12

最終輸出如下:

<code>1進入了1:40 2進入了2:我是小菜 3進入mod 4參數接受的數值{name=我是小菜;age=12} 5model傳過來的值:{age=40, user_name=我是小菜} /<code>標記在方法的參數上。

標記在方法的參數上,會將客戶端傳遞過來的參數按名稱注入到指定對象中,並且會將這個對象自動加入ModelMap中,便於View層使用.
我們在上面的類中加入一個方法如下

<code> 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 } /<code>

在瀏覽器中輸入訪問地址並且加上參數:
http://localhost:8081/api/test/mod2?name=我是小菜&age=12
最終輸出:

<code>1進入了1:40 2進入了2:我是小菜 3進入mod2 4user_name:我是小菜 5name:我是小菜 6age:40 7model:{user_name=我是小菜, /<code>

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對象中,便於使用。

7. @Cacheable

用來標記緩存查詢。可用用於方法或者類中,
當標記在一個方法上時表示該方法是支持緩存的,
當標記在一個類上時則表示該類所有的方法都是支持緩存的。
參數列表

<code>@Cacheable(value="UserCache")// 使用了一個緩存名叫 accountCache public Account getUserAge(int id) { //這裡不用寫緩存的邏輯,直接按正常業務邏輯走即可, //緩存通過切面自動切入 int age=getUser(id); return age; } /<code>

8. @CacheEvict

用來標記要清空緩存的方法,當這個方法被調用後,即會清空緩存。 @CacheEvict(value=”UserCache”)
參數列表

9. @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方式進行裝配;如果沒有匹配,則回退為一個原始類型進行匹配,如果匹配則自動裝配;

10. @PostConstruct

用來標記是在項目啟動的時候執行這個方法。用來修飾一個非靜態的void()方法也就是spring容器啟動時就執行,多用於一些全局配置、數據字典之類的加載

被@PostConstruct修飾的方法會在服務器加載Servlet的時候運行,並且只會被服務器執行一次。PostConstruct在構造函數之後執行,init()方法之前執行。PreDestroy()方法在destroy()方法執行執行之後執

11. @PreDestroy

被@PreDestroy修飾的方法會在服務器卸載Servlet的時候運行,並且只會被服務器調用一次,類似於Servlet的destroy()方法。被@PreDestroy修飾的方法會在destroy()方法之後運行,在Servlet被徹底卸載之前

12.@Repository

用於標註數據訪問組件,即DAO組件

13.@Component

泛指組件,當組件不好歸類的時候,我們可以使用這個註解進行標註

14.@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實例。**

15. @SessionAttributes

默認情況下Spring MVC將模型中的數據存儲到request域中。當一個請求結束後,數據就失效了。如果要跨頁面使用。那麼需要使用到session。而@SessionAttributes註解就可以使得模型中的數據存儲一份到session域中

參數:
names:這是一個字符串數組。裡面應寫需要存儲到session中數據的名稱。
types:根據指定參數的類型,將模型中對應類型的參數存儲到session中
value:和names是一樣的。

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

16. @Required

適用於bean屬性setter方法,並表示受影響的bean屬性必須在XML配置文件在配置時進行填充。否則,容器會拋出一個BeanInitializationException異常。

17. @Qualifier

當你創建多個具有相同類型的 bean 時,並且想要用一個屬性只為它們其中的一個進行裝配,在這種情況下,你可以使用 @Qualifier 註釋和 @Autowired 註釋通過指定哪一個真正的 bean 將會被裝配來消除混亂。

18.@PathVariable

@PathVariable可以用來映射URL中的佔位符到目標方法的參數中

<code>@RequestMapping("/testPathVariable/{id}") public String testPathVariable(@PathVariable("id") Integer id){ System.out.println("testPathVariable:"+id); return SUCCESS; } /<code>

最後解釋一下ajax相關注解:
Ajax相關注解
1.@RestController:定義的控制器所有方法默認返回的都是 @ResponseBody


的方法, 都會將返回值轉換為JSON。注意:@RestController=@Controller+@ResponseBody

2.@ResponseBody:設置了 @ResponseBody 以後如果控制器方法返回了Java Bean 對象
則這個JavaBean會被轉換為 JSON 對象, 放到響應的正文中發送瀏覽器
而且響應的 ContentType是 application/json, 表示JSON類型數據
3.@GetMapping:專門處理get類型請求
4.@PostMapping:專門處理post類型請求

注:@GetMapping("/get_test") 和 @RequestMapping(value = “/get_test”,method = RequestMethod.GET)等價的就是為了簡化 RequestMapper 專門用於處理Get請求
圖解:

19.@Data

類名前面添加@Data註解,lombok(插件,可以節省實體類代碼)會在類的編譯期間為類添加getter,setter,toString方法。添加全屬性筆記equals、hashCode方法。(說白了就是節省實體類的代碼,不用再寫get、set。。。。。等方法)


測試之後,lombok確實自動生成了以上的一些方法。

最後

感謝你看到這裡,看完有什麼的不懂的可以在評論區問我,覺得文章對你有幫助的話記得給我點個贊,每天都會分享java相關技術文章或行業資訊,歡迎大家關注和轉發文章!