Spring中注解大全及应用

最新推荐文章于 2024-08-06 00:22:07 发布
置顶 最新推荐文章于 2024-08-06 00:22:07 发布
阅读量163 收藏 1
点赞数 1
分类专栏： java 文章标签： spring注解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qxh_1/article/details/84746166
版权

@Controller

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

1    @Controller
2    public 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格式。

1    @RestController
2    public 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

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

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

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

1   public 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);

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}
5    model传过来的值:{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
4    user_name:我是小菜
5    name：我是小菜
6    age:40
7    model:{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”}
keykey@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   
2    public Account getUserAge(int id) {  
3        //这里不用写缓存的逻辑，直接按正常业务逻辑走即可，
4        //缓存通过切面自动切入  
5        int age=getUser(id);   
6        return age;   
7    } 

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

@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是一样的。

 1    @Controller
 2    @SessionAttributes(value={"names"},types={Integer.class})
 3    public 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 将会被装配来消除混乱。

Autism_Autism
关注
专栏目录
spring源码注释中文
04-12
Spring 框架是 Java 开发中的一个核心组件，它为构建可维护、模块化和松耦合的应用程序提供了一种强大的方式。Spring 源码注释中文版的提供，使得开发者能够更加深入地理解 Spring 的工作原理，无需经过复杂的编译...
spring源码中英文注释
01-12
这个压缩包文件中的"spring源码 中英文注释"为开发者提供了一个深入理解Spring框架内部工作原理的机会。通过阅读源码和注释，我们可以更清晰地了解Spring如何管理依赖注入、AOP（面向切面编程）、事务管理、上下文...
Spring中注解大全和应用
编程无界的博客
09-02 8890
@Controller @RestController： @Service @Autowired @RequestMapping @RequestParam @ModelAttribute @Cacheable @CacheEvict @Resource @PostConstruct @PreDestroy @Repository ...
Spring常用注解（绝对经典）
热门推荐
学Java，找哪吒
07-14 17万+
Spring注解方式减少了配置文件内容，更加便于管理，并且使用注解可以大大提高了开发效率！
Spring中常用注解及作用
ZRM99114的博客
07-31 2744
Spring常见注解及用法
Spring、SpringAOP、SpringMVC、SpringBoot注解大全及解释
weixin_60589106的博客
11-25 1337
注解 解释 Spring @Autowired Spring提供的工具（由Spring的依赖注入工具（BeanPostProcessor、BeanFactoryPostProcessor）自动注入。） Spring @Configuration 声明当前类是一个配置类（相当于一个Spring配置的xml文件） Spring @Bean 注解在方法上，声明当前方法的返回值为一个Bean。返回的Bean对应的类中可以定义init()方法和destro...
Spring框架中的重要注解及其应用
✨ 欢迎来到【Seal ^_^ 的CSDN博客】！这里是我记录技术心得、分享经验的地方。✨
08-06 8978
注解（Annotations）扮演了至关重要的角色，它们极大地简化了Spring应用的配置和开发过程。通过注解，能够以声明式的方式定义Spring组件的行为和属性，而无需编写大量的XML配置文件。
Spring注解大全_spring应用层_spring注解大全_控制层注解_
09-29
应用在MVC层（控制层）DispatcherServlet会自动扫描注解了此注解的类，然后将web请求映射到注解了RequestMapping的方法上。Service 组合注解（组合了@Component注解），应用在service层（业务逻辑层）
spring注解整理，及应用
06-05
Spring 注解整理及应用 Spring 框架中提供了许多注解来简化开发过程，这些注解可以分为多个类别，如 Controller、Service、DAO 等。下面我们将对 Spring 中常用的注解进行整理和解释： 一、Controller 相关注解 *...
spring 源码中文注释
12-11
Spring框架是Java开发中最广泛应用的轻量级框架之一，它以IoC（Inversion of Control，控制反转）和AOP（Aspect Oriented Programming，面向切面编程）为核心，极大地简化了企业级应用的开发工作。这份"spring 源码...
MongoDB分片集群搭建教程：副本集创建与数据分片
11-12
内容概要：本文提供了详细的MongoDB分片集群的搭建指导，涵盖了从环境准备、配置文件编写、副本集的建立、主节点的选择、配置服务器和数据分片服务器的配置到最后的路由节点的搭建与操作整个流程，以及对数据库的哈希与范围两种分片策略的应用介绍和具体命令执行。 适合人群：熟悉NoSQL数据库概念并对MongoDB有一定了解的技术人员，尤其是在大型数据管理和分布式数据库架构设计中有需求的开发者。 使用场景及目标：帮助技术人员掌握构建高效能、高可用性的MongoDB分片集群的方法，适用于处理大规模、实时性强的数据存储与读取场景。 其他说明：文中通过实例演示了每个步骤的具体操作方法，便于跟随文档实操，同时也介绍了可能遇到的问题及其解决方案，如在没有正确配置的情况下试图写入数据时出现错误等情况的处理。
CPPC++_嵌入式硬件的物联网解决方案blinker库与Arduino ESP8266 ESP32一起工作.zip
11-12
CPPC++_嵌入式硬件的物联网解决方案blinker库与Arduino ESP8266 ESP32一起工作
CPPC++_逆向调用QQ Mojo IPC与WeChat XPlugin.zip
11-12
CPPC++_逆向调用QQ Mojo IPC与WeChat XPlugin
CPPC++_现代活动指标.zip
11-12
CPPC++_现代活动指标
CPPC++_Xournal是一款手写笔记软件，支持PDF注释，使用C语言编写，支持GTK3，支持Linux，如Ubu.zip
11-12
CPPC++_Xournal是一款手写笔记软件，支持PDF注释，使用C语言编写，支持GTK3，支持Linux，如Ubu
基于SSM学生实习管理系统前台小程序与后台管理系统开发实践
11-12
资源概述： 本资源提供了一套完整的学生实习管理系统解决方案，涵盖了前台小程序页面与后台管理系统两大模块。前台小程序页面设计简洁直观，用户可根据不同身份（学生或企业）进行登录。学生用户能够方便地浏览并投递感兴趣的实习岗位，而企业用户则能轻松发布实习信息，吸引优秀人才。后台管理系统功能全面，包括个人中心、首页、学生管理、教师管理、企业管理、招聘管理、评分管理以及实习管理等多个方面，为管理员提供了强大的数据管理和操作工具。 技术栈亮点： SSM框架：系统后台采用Spring、Spring MVC和MyBatis Plus（简称SSM）作为核心开发框架，确保了系统的稳定性、可扩展性和可维护性。Spring作为控制反转（IoC）和面向切面编程（AOP）的容器，为系统提供了强大的业务逻辑处理能力；Spring MVC则负责处理Web请求和响应，实现了前后端的分离；MyBatis Plus作为持久层框架，简化了数据库操作，提高了开发效率。 MySQL数据库：系统采用MySQL作为数据库存储解决方案，支持大数据量的存储和高效查询。 如有侵权请联系我删除，谢谢
微服务闪聚支付项目.zip
最新发布
11-12
微服务闪聚支付项目
Rust 与 Java 互调实战示例
11-12
博客链接 https://blog.csdn.net/weixin_47560078/article/details/143714557 文章从原理介绍出发，实现了 Rust 与 Java 的互调。利用 JNI 技术，可以充分发挥 Rust 的性能优势，同时保持 Java 的跨平台特性。这种技术组合适用于对性能要求较高的应用场景，如图像处理、数据分析和系统级编程等。
CPPC++_这是我翻译的艾根中文文档.zip
11-12
cppc++
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值