Spring常用注解详解

最新推荐文章于 2024-05-27 20:05:16 发布
最新推荐文章于 2024-05-27 20:05:16 发布
阅读量1.2k 收藏 6
点赞数
分类专栏： springBoot学习笔记 文章标签： 注释 SpringBootApplication RestController Autowired spring注解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sanbowla/article/details/81136274
版权

文章目录

一、@ComponentScan

源码：

@Retention(value=RUNTIME)
@Target(value=TYPE)
@Documented
@Repeatable(value=ComponentScans.class)
public @interface ComponentScan
  • @ComponentScan注解用于配置组件扫描，在spring xml配置文件中用<context:component-scan>标签来表示。可以配置basePackageClasses()或basePackages()来定义要扫描的特定包，如果未定义，则从声明此注解的类的包中扫描（组件注解包括@Controller、@Service、@Component等）。

1. basePackages

  • 用于配置扫描被注解的组件的包
  • 例如：
@ComponentScan(basePackages={"com.fullexception.controller","com.fullexception.service"})
  • 指定扫描com.fullexception.controller和com.fullexception.service包。

2. value

  • basePackages的简写版，当只需要配置一个属性的时候可以用此属性
  • 例如：
    @ComponentScan(value="com.fullexception.controller")
  • 或者
    @ComponentScan("com.fullexception.controller")
  • 扫描com.fullexception.controller包。

3. basePackageClasses

  • 类型安全版的basePackages
  • 例如：
@ComponentScan(basePackageClasses={UserController.class, UserService.class})
  • 扫描UserController和UserService类所在的包。

4. nameGenerator

  • 指定bean命名策略的方法，默认的命名策略为AnnotationBeanNameGenerator
protected String buildDefaultBeanName(BeanDefinition definition) {  
    String shortClassName = ClassUtils.getShortName(definition.getBeanClassName());  
    return Introspector.decapitalize(shortClassName);  
}

  • 观察上述源码，默认命名规范得到的是首字母小写的类名

  • 我们可以自定义命名规范，创建AimeeAnnotationBeanNameGenerator类并继承AnnotationBeanNameGenerator，重写buildDefaultBeanName方法，得到类全名。

package com.fullexception.util;

import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationBeanNameGenerator;

public class AimeeAnnotationBeanNameGenerator extends AnnotationBeanNameGenerator {
	@Override
	protected String buildDefaultBeanName(BeanDefinition definition) {  
        return definition.getBeanClassName();  
    }  
}

@ComponentScan(nameGenerator=AimeeAnnotationBeanNameGenerator.class)
  • 绕过spring自动注入bean，可以通过类全名的方式手动获得类

ApplicationContext.getBean("com.fullexception.service.serviceImpl.UserServiceImpl")

5. lazyInit

  • 指定被扫描的bean是否注册为懒加载模式。
  • 例如：

@ComponentScan(lazyInit=true)

6. scopeResolver

  • 继承自ScopeMetadataResolver，用来解析已经检测到的组件。

7. scopedProxy

  • 指示是否应该为检测到的组件生成代理，这在使用代理样式的方式时可能是必要的。
    默认情况下是遵从用于执行实际扫描的组件扫描器的默认行为。

8. resourcePattern

  • 控制符合组件检测的类文件。

9. useDefaultFilters

  • 指示是否应该启用带有@component、@Repository、@service或@controller注解的类的自动检测。
    例如：

@ComponentScan(useDefaultFilters=false)

10. includeFilters

  • 指定哪些类型适合进行组件扫描。
  • 将basePackages()中指定的范围再次筛选缩小至符合指定的拦截器要求的组件。
    注意，如果指定的话，这些过滤器将被应用于默认过滤器。在指定的基本包下，与给定的过滤器相匹配的任何类型都将被包括在内，即使它不符合缺省过滤器（也就是说，不使用@component注解）。

11. excludeFilters

  • 指定哪些类型不适合进行组件扫描。

二、@SpringBootApplication

  • 源码：
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(excludeFilters={@ComponentScan.Filter(type=CUSTOM,classes=TypeExcludeFilter.class),})
public @interface SpringBootApplication
  • 被SpringBootApplication注解的类相当于是一个配置类，它声明一个或多个@bean方法并且触发自动配置和组件扫描功能，引用本注解相当于@Configuration、@EnableAutoConfiguration和@ComponentScan三个注解效果的叠加

1. scanBasePackages

  • 用于配置组件扫描的基本包。可以用scanBasePackageClassess()这种类型安全的方式来替代scanBasePackages

  • 例如：
    @SpringBootApplication(scanBasePackages={"com.fullexception.controller","com.fullexception.service"})

  • 或者
    @SpringBootApplication(scanBasePackages="com.fullexception.controller")

  • 在进行组件扫描的时候会在名称为com.fullexception.controller和com.fullexception.service的包下进行扫描。

2. scanBasePackageClasses

  • scanBasePackages的类型安全替代方案。配置指定类所在的包
  • 例如：
    @SpringBootApplication(scanBasePackageClasses ={com.fullexception.entity.Article.class})
  • 扫描Article类所在的包

3. exclude

  • 按class将指定的类排除在自动配置之外（类型安全）。
  • 例如：
    @SpringBootApplication(exclude=Article.class)
  • 在自动配置的时候不会配置Article类

4. excludeName

  • 按名称将指定的类排除在自动配置之外。

  • 例如：
    @SpringBootApplication(excludeName="com.fullexception.entity.User")

  • 或者
    @SpringBootApplication(excludeName={"com.fullexception.entity.Article", "com.fullexception.entity.User"})

  • 在自动配置的时候不会配置com.fullexception.entity包下的Article和User类

  • 实际应用：扫描com.fullexception.entity下的所有类，但排除Article类
    @SpringBootApplication(scanBasePackages={"com.fullexception.controller"), exclude=Article.class)

三、@EnableAutoConfiguration

  • 源码：
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import(value=AutoConfigurationImportSelector.class)
public @interface EnableAutoConfiguration
  • 使Spring应用上下文有自动配置的功能，尝试猜测和配置可能需要的bean，自动配置类通常基于类路径和自定义的bean。
  • 如果添加了@SpringBootApplication注解，自动配置上下文将自动激活，并且添加@EnableAutoConfiguration注解，但是不会添加@EnableAutoConfiguration注解的任何附加功能。

1. exclude

  • 排除特定的类，这样它就永远不会被应用了（类型安全）。
  • 例如：
    @EnableAutoConfiguration(exclude={UserServiceImpl.class, UserMapper.class})
  • 不会应用UserService和UserMapper类。

2. excludeName

  • 功能同上，通过字符串表示的类名来完成过滤。
  • 例如：
    @EnableAutoConfiguration(excludeName={"UserServiceImpl"})
  • 不会应用UserServiceImpl类。

四、@Component

  • 源码：
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Indexed
public @interface Component
  • 表示带有@Component注解的类是一个“组件”。在扫描组件时，这些类被认为是自动检测的候选对象。
  • 其他类级注解也可以被看作是标识一个组件，通常是一种特殊的组件：例如@repository注解或AspectJ的@aspect注解。

1. value

  • 可以给定一个逻辑组件的建议名称，在自动检测组件的情况下，它将被转换成Spring bean。

五、@RestController

  • 源码：
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Controller
@ResponseBody
public @interface RestController
  • 一个方便的注解，它本身带有@controller和@responsebody。
  • 被注解的类作为控制器，并且返回值直接写进http响应正文中（不会跳转页面，返回值一般为json或xml等格式的数据），异步调用使用居多。

1. value

  • 可以给定一个逻辑组件的建议名称，在自动检测组件的情况下，它将被转换成Spring bean。

六、@Controller

  • 源码：
@Target(value=TYPE)
@Retention(value=RUNTIME)
@Documented
@Component
public @interface Controller

  • 表明被注解的类是一个控制器

  • 这个注解可以理解为@Component的一个特殊版本，允许实现类在类路径扫描时被检测到，它通常和基于@RequestMapping的类（例如@GetMapping、@PostMapping、@PutMapping、@DeleteMapping等等）配合使用。

1. value

  • 可以给定一个逻辑组件的建议名称，在自动检测组件的情况下，它将被转换成Spring bean。

七、@ResponseBody

  • 源码：
@Target(value={TYPE,METHOD})
@Retention(value=RUNTIME)
@Documented
public @interface ResponseBody
  • 此注解表示方法的返回值要绑定到web响应主体中（异步调用时经常使用，返回值多为json、xml等数据体），不会进行跳转，支持servlet环境中的注解处理程序方法， 可在方法上添加注解。
  • 在4.0版本后，此注解支持添加到类型（Class）级别上，在这种情况下注解属性是继承的，不需要单独再去为方法添加注解。

八、@Autowired

  • 源码：
@Target(value={CONSTRUCTOR,METHOD,PARAMETER,FIELD,ANNOTATION_TYPE})
@Retention(value=RUNTIME)
@Documented
public @interface Autowired
  • @Autowired是用在JavaBean中的注解，通过类型、类名称等形式，用来给指定的字段或方法注入所需的外部资源。
  • 定义一个UserService接口
public interface UserService {
	String getUserName();
}
  • UserService的实现类
@Service("userService")
public class UserServiceImpl implements UserService {
	@Override
	public User getUserName() {
		return "张三";
	}
}
  • 接下来定义Controller
@Controller
public class UserController {
	@Autowired
	private UserService userService2;
}
  • 这时程序运行@Autowired时是通过比对类型的方式到IoC容器中查找UserService的实现，目标是UserServiceImpl（即便UserServiceImpl里@Service（“userService”）的名称为userService，与controller中定义的userService2不同也可以成功注入），因为容器中目前只有一个实现。
  • 那这时我们再定义一个实现
@Service("userService1")
public class UserServiceImpl1 implements UserService {
	@Override
	public User getUserName() {
		return "李四";
	}
}
  • 再次运行时，控制台出现如下警告
Field userService2 in com.fullexception.controller.UserController required a single bean, but 2 were found:
	- userService: defined in file [D:\Users\Administrator\Documents\workspace-sts-3.8.4.RELEASE\alicia_do\target\classes\com\fullexception\service\serviceImpl\UserServiceImpl.class]
	- userService1: defined in file [D:\Users\Administrator\Documents\workspace-sts-3.8.4.RELEASE\alicia_do\target\classes\com\fullexception\service\serviceImpl\UserServiceImpl1.class]

-我们可以看到错误提示信息，显然系统想通过名称去对比，但是没有发现目标，因此提示类型符合的有两条，但是名称userService2和userService、userService1对应不上。由此可见，多个实现采用的是比对名称的方式。

1. required

  • 当不能确定 Spring 容器中一定拥有某个类的 Bean 时，可以在需要自动注入该类 Bean 的地方可以使用 @Autowired(required = false)
  • 上述方法中如果UserService接口没有一个实现类，可以通过配置Controller中的@Autowired(required = false)来避免启动错误。

九、@PathVariable

  • 源码：
@Target(value=PARAMETER)
@Retention(value=RUNTIME)
@Documented
public @interface PathVariable

  • 注解指明参数绑定到URI模板变量，并通过@PathVariable注解取得url中的参数

  • 例：

@Autowired
private UserService userService;

@GetMapping(value = "/index/{id}")
public String showIndex(@PathVariable("id") Integer id, HttpSession session) {
	User user = userService.getUserById(id);
	session.setAttribute("user", user);
	return "index";
}
  • 访问url： http://127.0.0.1:8080/index/1

1. value/name

  • 要绑定的变量的名称
  • 例如：
@PathVariable(value="id")
@PathVariable(name="id")
@PathVariable("id")

感谢阅读：

骑着马桶弹吉他
关注
  • 0
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
专栏目录
SpringBoot常用注解详解含使用示例（值得珍藏）
02-01
本文将详细介绍Spring Boot中最常用的注解，包括@SpringBootApplication、@Component、@Service、@Repository、@Controller、@RequestMapping、@GetMapping、@PostMapping、@PutMapping、@DeleteMapping、@Autowired...
Spring常用注解（绝对经典），全靠这份Java知识点PDF大全
m0_65321095的博客
12-19 1万+
@Bean public ColorFactoryBean colorFactoryBean(){ return new ColorFactoryBean(); } //创建一个spring定义的FactoryBean public class ColorFactoryBean implements FactoryBean { //返回一个Color对象，并将Color添加到容器中 public Color getObject() throws Exception { System.out.println(
Spring 中所有注解
weixin_44371237的博客
01-28 2276
Spring中的注解主要分为两类： 类级别的注解：如@Component、@Repository、@Controller、@Service以及JavaEE6的@ManagedBean和@Named注解，都是添加在类上面的类级别注解。 类内部的注解：如@Autowire、@Value、@Resource以及EJB和WebService相关的注解等，都是添加在类内部的字段或者方法上的类内部注解。 ...
Spring常用注解（超全面）
最新发布
东皋长歌的专栏
05-27 1683
EnableCaching：开启注解式的缓存支持；@Resource：由JSR-250提供 @Autowired、@Inject是默认按照类型匹配的，@Resource是按照名称匹配的，@Autowired如果需要按照名称匹配需要和@Qualifier一起使用，@Inject和@Name一起使用。@RestController 该注解为一个组合注解，相当于@Controller和@ResponseBody的组合，注解在类上，意味着，该Controller的所有方法都默认加上了@ResponseBody。
Spring注解详解
gelingxian的博客
03-14 1万+
一、Spring注解驱动开发入门 spring在2.5版本引入了注解配置的支持，同时从Spring 3版本开始，Spring JavaConfig项目提供的许多特性成为核心Spring框架的一部分。因此，可以使用Java而不是XML文件来定义应用程序类外部的bean。在这里面官方文档为我们提供了四个基本注解@Configuration,@Bean,@Import,@DependsOn 用于注解驱动的注解 1.1、@Configuration 1.1.1、源码 @Target(Ele
Spring注解分类及详解
十年以上架构设计经验，专注于软件架构和人工智能领域，对机器视觉、NLP、音视频等领域都有涉猎
01-10 2785
Spring Framework是一个开源的Java平台，广泛用于创建高性能的企业应用程序。随着Spring的发展，注解（Annotation）已经成为了配置Spring应用程序的主要方式，逐渐取代了传统的XML配置。使用注解可以使代码更加简洁明了，提高开发效率和可读性。
Spring常用注解。
ORANGEFISHs的博客
06-01 5433
spring常用注解：
spring3注解详解
05-14
Spring 3.0 是一个重要的版本，它引入了大量的注解，极大地简化了Spring框架的配置，使得开发人员能够更加专注于业务逻辑，而不再是XML配置。本文将深入解析Spring 3.0中的主要注解，帮助你更好地理解和使用它们。 ...
浅谈spring 常用注解
08-28
浅谈Spring常用注解 浅谈Spring常用注解是Spring框架中的一些基本概念，了解这些概念对于 MASTERING SPRING Framework非常重要。本文将对Spring中常用的注解进行分类和介绍，并对每个注解的使用进行解释。 一、...
SpringAOP中的注解配置详解
08-25
SpringAOP中的注解配置详解 SpringAOP中的注解配置详解是Spring框架中的一种非常重要的技术，它允许开发者在不修改源代码的情况下实现对业务逻辑的拦截和扩展。本文将详细介绍SpringAOP中的注解配置详解，包括使用...
Spring常用注解（绝对经典）
热门推荐
weixin_43745321的博客
05-25 1万+
目录 一、前言 1、xml和注解的最佳实践： 2、使用注解唯一需要注意的就是，必须开启注解的支持： 二、Spring的常用注解 1、给容器中注入组件 2、注入bean的注解 3、@JsonIgnore 4、初始化和销毁方法 5、Java配置类相关注解 6、切面（AOP）相关注解 7、@Bean的属性支持 8、@Value注解 9、环境切换 10、异步相关 11、定时任务相关 12、Enable***注解说明 13、测试相关注解 14、@EqualsAndHashCode.
Spring注解大全（示例详解）
Nothing is impossible to a willing heart.
12-15 3542
Controller 标识一个该类是Spring MVC controller处理器，用来创建处理http请求的对象. @Controller public class TestController { @RequestMapping("/test") public String test(Map<String,Object> map){ return "hello"; } } RestController spring4
Spring高手之路2——深入理解注解驱动配置与XML配置的融合与区别
卓越无关环境，保持空杯心态——靡不有初，鲜克有终
05-26 8228
本文旨在深入探讨Spring框架的注解驱动配置与XML配置，揭示两者之间的相似性与差异。我们首先介绍了配置类的编写与Bean的注册，然后比较了注解驱动的IOC依赖注入与XML依赖注入。文章进一步解析了Spring的组件注册与组件扫描，包括使用@ComponentScan和XML启用component-scan的情况，以及不使用@ComponentScan的场景。接下来，我们深入探讨了其他相关的组件注册注解。最后，我们展示了如何将注解驱动的配置与XML驱动的配置结合使用，并通过思考总结部分提出了一些重要的问题
Spring注解大全（史上最全，字母编号，有实例）
qq_46138160的博客
12-11 5431
目录 A @Accessors 链式编程使用。需要搭配@Getter和@Setter使用。主要有三个参数： 序号 参数名 介绍 1 chain 链式 2 fluent 流式（若无显示指定chain的值，也会把chain设置为true） 3 prefix 生成指定前缀的属性的getter与setter方法，并且生成的getter与setter方法时会去除前缀 我们发现prefix可以在生成get/set的时候，去掉xxx等prefix前缀，达到很好的一致性。但是，
Spring中的常用注解，你都用了哪一些？
weixin_34203832的博客
02-09 1085
2019独角兽企业重金招聘Python工程师标准>>> ...
Spring中的注解详细介绍
禾日香的博客
12-16 1801
Resource的默认注入方式为ByName（根据名称进行匹配），若名称匹配不了，则会ByType（根据类型进行匹配注入）。@Scope可以指定Bean的作用范围，这里的作用范围：是指被修饰的实例Bean对象的作用范围。[这里的名称就是 @Service("xxx") 中的 xxx] 这时就会根据名称ByName进行匹配并注入。Spring中的注解详细介绍
java spring注解大全_spring注解大全
weixin_32019577的博客
02-27 162
注解解释1@Controller组合注解(组合了@Component注解)，应用在MVC层(控制层),DispatcherServlet会自动扫描注解了此注解的类，然后将web请求映射到注解了@RequestMapping的方法上。2@Service组合注解(组合了@Component注解)，应用在service层(业务逻辑层)3@Reponsitory组合注解(组合了@Component注解)，...
Spring常用注解详解大全(建议收藏)
m0_51538362的博客
03-15 5518
@SuppressWarnings(“deprecation”)**就表示我们忽略了deprecation这样的一个警告。 JDK注解作用总结： @Override 表示当前方法覆盖了父类的方法 @Deprecation 表示方法已经过时,方法上有横线，使用时会有警告。 @SuppviseWarnings 表示关闭一些警告信息(通知java编译器忽略特定的编译警告) SpringMVC的注解有： … 1、@Controller 2、@RequestMapping RequestMapping是一个用来处理请
spring所有注解详解
05-04
Spring是一个Java开发框架，提供了许多注解来简化开发。下面是Spring中常用的注解的详解： 1. @Autowired：自动装配，用于自动注入依赖项。 2. @Component：用于标记一个类为Spring容器管理的组件。 3. @Controller：用于标记一个类为Spring MVC控制器。 4. @Service：用于标记一个类为服务层组件。 5. @Repository：用于标记一个类为数据访问层组件。 6. @RequestMapping：用于映射请求到处理程序方法。 7. @PathVariable：用于获取请求URL中的变量值。 8. @RequestParam：用于获取请求参数的值。 9. @ResponseBody：用于将返回值直接写入响应体中。 10. @RestController：用于标记一个类为Spring MVC控制器，并且默认所有方法都返回JSON格式的数据。 11. @Configuration：用于标记一个类为配置类，相当于一个XML配置文件。 12. @Bean：用于在配置类中声明一个Bean。 13. @Value：用于获取配置文件中的属性值。 14. @Qualifier：用于指定自动装配时使用的Bean名称。 15. @Scope：用于指定Bean的作用域，例如singleton、prototype等。 16. @Transactional：用于标记一个方法为事务方法。 17. @Async：用于标记一个方法为异步方法。 18. @PostConstruct：用于标记一个方法为Bean初始化方法。 19. @PreDestroy：用于标记一个方法为Bean销毁方法。 以上是Spring中常见的注解的详解，使用这些注解可以使开发更加简单和高效。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值