Loading [MathJax]/jax/input/TeX/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >Spring 中注解大全和应用

Spring 中注解大全和应用

作者头像
芋道源码
发布于 2018-11-08 07:24:41
发布于 2018-11-08 07:24:41
48600
代码可运行
举报
文章被收录于专栏:芋道源码1024芋道源码1024
运行总次数:0
代码可运行
  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请求的对象.

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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格式。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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)

@RequestMapping

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

用过RequestMapping的同学都知道,他有非常多的作用,因此详细的用法 我会在下一篇文章专门讲述,请关注公众号哦,以免错过。

@RequestParam

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1public Resp test(@RequestParam Integer id){
2        return Resp.success(customerInfoService.fetch(id));
3    }

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1public Resp test(@RequestParam(value="course_id") Integer id){
2        return Resp.success(customerInfoService.fetch(id));
3    }

其中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);

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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方法

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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    }

我们在当前类下建一个请求方法:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 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

最终输出如下:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1进入了140
2进入了2:我是小菜
3进入mod
4参数接受的数值{name=我是小菜;age=12}
5model传过来的值:{age=40, user_name=我是小菜}
2. 标记在方法的参数上。

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

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 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 最终输出:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
1进入了140
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中定义.

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
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中
  3. value:和names是一样的。
代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
 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 将会被装配来消除混乱。



本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2018-10-21,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 芋道源码 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
Spring中注解大全和应用
来源:juejin.im/post/5b8ac1c76fb9a019da27d910
Java团长
2018/12/21
3760
Spring中的18个注解,你会几个?
标识一个该类是Spring MVC controller处理器,用来创建处理http请求的对象.
田维常
2019/07/16
4130
Spring中的18个注解,你会几个
标识一个该类是Spring MVC controller处理器,用来创建处理http请求的对象.
java架构师
2019/05/24
4050
16个Spring注解,你知道的有几个?
标识一个该类是Spring MVC controller处理器,用来创建处理http请求的对象.
程序员追风
2019/08/18
4260
16个Spring注解,你知道的有几个?
Spring中的18个注解,你会几个?
https://m.toutiaocdn.com/i6693736960273416712
好好学java
2019/09/17
5030
Spring中的18个注解,你会几个?
Spring 中的 18 个注解,你会几个?
标识一个该类是 Spring MVC controller 处理器,用来创建处理 http 请求的对象。
良月柒
2019/06/14
4010
Spring 中的 18 个注解,你会几个?
SpringMVC常用注解标签详解
在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的View 进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法,你无需继承特定的类或实现特定的接口,只需使用@Controller 标记一个类是Controller ,然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射,这样的Controller 就能被外界访问到。此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象,它们可以通过Controller 的方法参数灵活的获取到。
Java团长
2018/08/03
1.1K0
SpringMVC 常用注解
1、@Controller      @Controller 用于标记在一个类上,使用它标记的类就是一个SpringMVC Controller 对象。分发处理器将会扫描使用了该注解的类的方法,并检测该方法是否使用了@RequestMapping 注解。@Controller 只是定义了一个控制器类,而使用@RequestMapping 注解的方法才是真正处理请求的处理器。      @Controller 标记在一个类上还不能真正意义上的说它就是SpringMVC 的一个控制器类,因为这个时候Spring
二十三年蝉
2018/02/28
4.5K0
Spring学习笔记(2)一DI依赖注入和Spring Bean配置、注解原理、动态注入
Spring容器是Spring框架的核心。容器将创建对象,它们连接在一起,配置它们,并从创建到销毁管理他们的整个生命周期。在Spring容器使用依赖注入(DI)来管理组成应用程序的组件。这些对象被称为Spring Beans。 IOC(Inversion of Control):传统的方法,当某个java对象A需要调用对象B时,是由调用者(对象A)通过new关键字来创建对象B的,而在Spring中,则是由spring完成创建的,所以“控制反转”了。Spring通过一种称作控制反转(IoC)的技术促进了低耦合。当应用了IoC,一个对象依赖的其它对象会通过被动的方式传递进来,而不是这个对象自己创建或者查找依赖对象。你可以认为IoC与JNDI(JNDI是 Java 命名与目录接口Java Naming and Directory Interface))相反——不是对象从容器中查找依赖,而是容器在对象初始化时不等对象请求就主动将依赖传递给它。 DI(Dependency Injection)—IOC的另一种表述方式:即组件以一些预先定义好的方式(例如: setter方法)接受来自如容器的资源注入.相对于 IOC而言,这种表述更直接。
黄规速
2022/04/14
8740
Spring学习笔记(2)一DI依赖注入和Spring Bean配置、注解原理、动态注入
springmvc 注解总结
转载自 https://www.cnblogs.com/xiaoxi/p/5718894.html
allsmallpig
2021/02/25
4990
Spring学习笔记(七)——SpringMVC常用的注解
常用的注解 1. RequestParam注解 1. 作用:把请求中的指定名称的参数传递给控制器中的形参赋值 2. 属性 1. value:请求参数中的名称 2. required:请求参数中是否必须提供此参数,默认值是true 3. 代码如下 /** * 测试RequestParam注解,默认必须传参数,可以使用required=false配置可以不传参 * 参数的名字必须为value的值 * @param name * @return *
不愿意做鱼的小鲸鱼
2022/09/24
3190
Spring学习笔记(七)——SpringMVC常用的注解
硬核!学会SpringMVC从这篇开始
大家好,我是小菜,一个渴望在互联网行业做到蔡不菜的小菜。可柔可刚,点赞则柔,白嫖则刚!
蔡不菜丶
2020/11/11
6780
硬核!学会SpringMVC从这篇开始
springMVC的常用注解
SessionAttributes注解 作用:用于多次执行控制器方法间的参数共享 属性 value:指定存入属性的名称
暴躁的程序猿
2022/03/23
2130
springMVC的常用注解
_Spring MVC相关注解运用 —— 上篇
但是如果请求路径是: http://localhost:8080/c3/annotation1?username=10
会洗碗的CV工程师
2023/11/18
1640
_Spring MVC相关注解运用 —— 上篇
Spring Boot进阶教程——注解大全(建议收藏!)
在Spring Core注解中,主要讨论Spring DI和Spring IOC中使用的Spring核心注释。众所周知,Spring DI和Spring IOC是Spring框架的核心概念。所以介绍org.springframework.beans.factory.annotation 和org.springframework.context.annotation 包中的注解。这两个包中注解有很多,就抽取其中的15个注解。
烂猪皮
2021/01/13
2.4K0
Spring Boot进阶教程——注解大全(建议收藏!)
springmvc常用注解总结(面试经常问)
在SpringMVC 中,控制器Controller 负责处理由DispatcherServlet 分发的请求,它把用户请求的数据经过业务处理层处理之后封装成一个Model ,然后再把该Model 返回给对应的View 进行展示。在SpringMVC 中提供了一个非常简便的定义Controller 的方法,你无需继承特定的类或实现特定的接口,只需使用@Controller 标记一个类是Controller ,然后使用@RequestMapping 和@RequestParam 等一些注解用以定义URL 请求和Controller 方法之间的映射,这样的Controller 就能被外界访问到。此外Controller 不会直接依赖于HttpServletRequest 和HttpServletResponse 等HttpServlet 对象,它们可以通过Controller 的方法参数灵活的获取到。
xiaozhangStu
2023/05/04
2770
spring和springboot常用注解_Java常用注解
9、@JoinColumn、@OneToOne、@OneToMany、@ManyToOne
全栈程序员站长
2022/09/24
8240
Spring三兄弟:Spring、Spring Boot、Spring Cloud的100个常用注解大盘点
Spring Cloud是一个基于Spring Boot的云服务框架,它为构建分布式系统提供了一套简单易用的工具。Spring Cloud中定义了许多注解来帮助我们者更轻松地构建和配置微服务应用程序。以下是一些Spring Cloud中定义的常用注解的总结:
公众号:码到三十五
2024/03/19
6580
springmvc 其他
<!-- 配置直接转发的页面 --> <!-- 可以直接相应转发的页面, 而无需再经过 Handler 的方法. --> <mvc:view-controller path="/success" view-name="success"/> 地址输入success就可以直接访问succeess对应的succeess.jsp页面。 @sessionAtrributes({"name","name2"}) 注解在类上,将以name为键的 键值对 放入session中 @modelAttributes @M
yawn
2018/03/14
9330
spring注解
1.注解 @Controller控制器定义     和Struts1一样,Spring的Controller是Singleton的。这就意味着会被多个请求线程共享。因此,我们将控制器设计成无状态类。     在spring 3.0中,通过@controller标注即可将class定义为一个controller类。为使spring能找到定义为controller的bean,需要在spring-context配置文件中增加如下定义: <context:component-scan base-package
Ryan-Miao
2018/03/13
7240
相关推荐
Spring中注解大全和应用
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验