Spring自动装配（基于注解）

Posted 2023-04-01 洛卡JAVA架构师

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring自动装配（基于注解）相关的知识，希望对你有一定的参考价值。

从 Java 5 开始，Java 增加了对注解（Annotation）的支持，它是代码中的一种特殊标记，可以在编译、类加载和运行时被读取，执行相应的处理。开发人员可以通过注解在不改变原有代码和逻辑的情况下，在源代码中嵌入补充信息。

Spring 从 2.5 版本开始提供了对注解技术的全面支持，我们可以使用注解来实现自动装配，简化 Spring 的 XML 配置。

Spring 通过注解实现自动装配的步骤如下：
引入依赖
开启组件扫描
使用注解定义 Bean
依赖注入

引入依赖
使用注解的第一步，就是要在项目中引入以下 Jar 包。
org.springframework.core-5.3.13.jar
org.springframework.beans-5.3.13.jar
spring-context-5.3.13.jar
spring-expression-5.3.13.jar
commons.logging-1.2.jar
spring-aop-5.3.13.jar
注意，除了 spring 的四个基础 jar 包和 commons-logging-xxx.jar 外，想要使用注解实现 Spring 自动装配，还需要引入Spring 提供的 spring-aop 的 Jar 包。
开启组件扫描
Spring 默认不使用注解装配 Bean，因此我们需要在 Spring 的 XML 配置中，通过 context:component-scan 元素开启 Spring Beans的自动扫描功能。开启此功能后，Spring 会自动从扫描指定的包（base-package 属性设置）及其子包下的所有类，如果类上使用了 @Component 注解，就将该类装配到容器中。

<?xml version="1.0" encoding="UTF-8"?>

<context:component-scan base-package=“net.biancheng.c”></context:component-scan>

注意：在使用 context:component-scan 元素开启自动扫描功能前，首先需要在 XML 配置的一级标签中添加 context 相关的约束。

使用注解定义 Bean
Spring 提供了以下多个注解，这些注解可以直接标注在 Java 类上，将它们定义成 Spring Bean。

4. 基于注解方式实现依赖注入
我们可以通过以下注解将定义好 Bean 装配到其它的 Bean 中。

示例

创建一个名为 my-spring-autowire-demo 的 Java 工程。
将以下 jar 包导入到项目中。
org.springframework.core-5.3.13.jar
org.springframework.beans-5.3.13.jar
spring-context-5.3.13.jar
spring-expression-5.3.13.jar
commons.logging-1.2.jar
spring-aop-5.3.13.jar
在 net.biancheng.c.dao 包下，创建一个名为 UserDao 的接口，代码如下。
package net.biancheng.c.dao;
public interface UserDao
public void print();
在 net.biancheng.c.dao.impl 包下，创建 UserDao 的实现类 UserDaoImpl，代码如下。
package net.biancheng.c.dao.impl;
import net.biancheng.c.dao.UserDao;
import org.springframework.stereotype.Repository;
@Repository(“userDao”)
public class UserDaoImpl implements UserDao
@Override
public void print()
System.out.println(“C语言中文网”);
在 net.biancheng.c.service 包下，创建一个名为 UserService 的接口，代码如下。
package net.biancheng.c.service;
public interface UserService
public void out();
在 net.biancheng.c.service.impl 包下，创建 UserService 的实现类 UserServiceImpl，代码如下。
package net.biancheng.c.service.impl;
import net.biancheng.c.dao.UserDao;
import net.biancheng.c.service.UserService;
import org.springframework.stereotype.Service;
import javax.annotation.Resource;
@Service(“userService”)
public class UserServiceImpl implements UserService
@Resource
private UserDao userDao;
public UserDao getUserDao()
return userDao;

public void setUserDao(UserDao userDao)
this.userDao = userDao;

@Override
public void out()
userDao.print();
System.out.println(“一个精美而实用的网站”);
在 net.biancheng.c.controller 包下，创建一个名为 UserController 的类，代码如下。
package net.biancheng.c.controller;
import net.biancheng.c.service.UserService;
import org.springframework.stereotype.Controller;
import javax.annotation.Resource;
@Controller(“userController”)
public class UserController
@Resource
private UserService userService;
public UserService getUserService()
return userService;

public void setUserService(UserService userService)
this.userService = userService;

public void doStr()
userService.out();
System.out.println(“专注于分享优质编程教程。”);

在 src 目录下，创建 Spring 配置文件 Beans.xml，配置内容如下。

<?xml version="1.0" encoding="UTF-8"?>

<!--开启组件扫描功能-->
<context:component-scan base-package="net.biancheng.c"></context:component-scan>

在 net.biancheng.c 包下，创建一个名为 MainApp 的类，代码如下。
package net.biancheng.c;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import net.biancheng.c.controller.UserController;
public class MainApp
public static void main(String[] args)
ApplicationContext context = new ClassPathXmlApplicationContext(“Beans.xml”);
UserController userController = context.getBean(“userController”, UserController.class);
userController.doStr();
执行 MainApp 中的 main() 方法，控制台输出如下。
Java进阶营
一个精美而实用的公众号
专注于分享优质编程教程。

spring框架学习：Bean的装配方式 ——基于注解的装配自动装配

【序言】

在前面的例子中我们就可以看到了使用基于XML方式的缺点了：如果应用中有较多的Bean对象，则会导致xml文件过于臃肿，给后续的维护和升级工作造成困难。为此Spring提供了基于注解的方式。这也是我们最常使用的方式

基于注解装配

常用注解：

@Component：可以使用次数接描述Spring中的Bean，但它是一个泛化的概念，仅仅表示一个组件（Bean），并且可以作用于任何层次。使用时只需将该注解标注在相应的类上即可。
@Controller、@Service、@Repository，这三个注解是@Component注解的细化，分别用于标注在Controller（控制层）、Service层（业务层）、Dao层（数据访问层），作用与@Component相同。
@AutoWired：用于对Bean的属性变量、属性的setter方法及构造方法进行标注，配合对应的注解处理器完成Ben啊的自动装配工作，默认Bean类型进行装配。
@Resource：@AutoWired的加强版。默认按Bean实例名称装配。有name和type两个属性，可以通过type属性指定按Bean类型进行装配，此时就等同与@AutoWired。如果都没有指定，则先按实力名称装配，不能匹配在按照Bean类型装配，都无法匹配时，抛出NoSuchBeanDefinitionException异常
@Qualifier ：与@AutoWired注解配合使用，会将@AutoWired默认的按Bean类型（byType）装配修改为按Bean实例名（byName）装配，Bean的实例名称由@Qualifier注解参数指定。

在这里插入图片描述

UserDao 接口

package com.johnny.annotation.dao;

public interface UserDao {
	public void save();
}

package com.johnny.annotation.dao.imp;

import org.springframework.stereotype.Repository;

import com.johnny.annotation.dao.UserDao;

/**
 * 
 *在Dao层使用@Repository注解 相当于在xml中编写：<bean id = "userDao" class ="com.johnny.annotation.dao.imp.UserDaoImpl">
 */
@Repository("userDao")
public class UserDaoImpl implements UserDao {
	@Override
	public void save() {
		System.out.println("UserDao save!");
	}

}

在这里插入图片描述
UserService.java

package com.johnny.annotation.service;

public interface UserService {
	public void save();

}

UserServiceImpl

package com.johnny.annotation.service.imp;




import javax.annotation.Resource;

import org.springframework.stereotype.Service;

import com.johnny.annotation.dao.UserDao;
import com.johnny.annotation.service.UserService;

@Service("userService")
public class UserServiceImp implements UserService {
	
	/**
	 * 使用@Resource 注解 且指定name = userDao
	 * 相当于在配置文件 <property name="userDao" ref="userDao"/>
	 */
	@Resource(name = "userDao")
	private UserDao userDao;
	
	@Override
	public void save() {
		System.out.println("Userservice save!");
		userDao.save();

	}

}

在这里插入图片描述

UserController.java

package com.johnny.annotation.controller;


import javax.annotation.Resource;

import org.springframework.stereotype.Controller;

import com.johnny.annotation.service.UserService;

@Controller("userController")
public class UserController {
	
	@Resource(name="userService")
	private UserService userService;
	
	public void save() {
		System.out.println("UserControler save!");
		userService.save();
	}

}

bean-524.xml

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd" >
	<!-- 开启注解 -->
	<context:annotation-config />
	<!-- 声明3个Bean对应的3个实例  与XML装配不同的是 使用注解装配 不用使用ref   -->
	<bean id="userDao" class="com.johnny.annotation.dao.imp.UserDaoImpl" />
	<bean id="userService" class="com.johnny.annotation.service.imp.UserServiceImp" />
	<bean id="userController" class="com.johnny.annotation.controller.UserController" />

</beans>

在元素中增加了第4行，引入context命名空间，第7、8行增加对context的约束信息；然后通过配置
context:annotation-config/来开启注解处理器。最后分别定义3个Bean对应编写的实例。与XML装配不同的是，这里不需要配置子元素。

上述配置文件中的注解方式虽然较大程度地简化了XML文件中Bean的配置，但仍需要在Spring配置文件中一一配置相应的Bean，为此Spring注解提供了另一种高效的注解配置方式（对包路径下所有的Bean文件进行扫描）。配置方式如下：

<!-- 使用context命名空间 开启注解扫描器： 这样则无需在Spring配置文件中一一配置相应的Bean -->
<context:component-scan base-package = "com.johnny.annotation"/>

可用上述代码将bean524.xml文件中的9-14行代码换掉。

测试类MyTest.java

package com.johnny.annotation.test;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.johnny.annotation.controller.UserController;
import com.johnny.annotation.dao.UserDao;
import com.johnny.annotation.entity.User;


public class Mytest {

	public static void main(String[] args) {
		ApplicationContext applicationContext=new ClassPathXmlApplicationContext("com/johnny/annotation/beans/xml/bean-524.xml");
	    UserController userController= (UserController) applicationContext.getBean("userController");
		userController.save();
	}

}

通过Spring容器加载文件并获取UserController实例，最后嗲用save()方法，输出结果

UserControler save!
Userservice save!
UserDao save!

总结

使用注解定义bean，通过注解的形式将bean以及相应的属性值放入IOC容器中。
<context:component-scan base-package = “com.johnny.annotation”/> Spring在启动的时候，会根据base-package在该包中扫描所有类，查找这些类是否有注解@Component等注解。如果有，则将该类加入Spring IOC容器。

步骤：

在指定类增加注解
配置文件中添加注解扫描器，指定要扫描的包

自动装配

所谓自动装配，就是将一个Bean自动地注入到其他Bean的Property中。我们可以通过设置元素的autowire的属性值来实现自动装配Bean。

autowire属性有5个值，如下：
在这里插入图片描述

修改UserServiceImpl.java和UserController.java，分别增加类属性的setter方法。

package com.johnny.annotation.service.imp;




import javax.annotation.Resource;

import org.springframework.stereotype.Service;

import com.johnny.annotation.dao.UserDao;
import com.johnny.annotation.service.UserService;

@Service("userService")
public class UserServiceImp implements UserService {
	
	/**
	 * 使用@Resource 注解 且指定name = userDao
	 * 相当于在配置文件 <property name="userDao" ref="userDao"/>
	 */
	//基于单个注解方式：@Resource(name = "userDao")
	private UserDao userDao2;  //属性名userDao2
	


	public void setUserDao2(UserDao userDao2) {
		this.userDao2 = userDao2;
	}



	@Override
	public void save() {
		System.out.println("Userservice save!");
		userDao2.save();

	}

}

UserController.java

package com.johnny.annotation.controller;


import javax.annotation.Resource;

import org.springframework.stereotype.Controller;

import com.johnny.annotation.dao.UserDao;
import com.johnny.annotation.service.UserService;

@Controller("userController")
public class UserController {
	
	//基于单个注解方式：@Resource(name="userService")
	private UserService userService22;
	
	
	public void setUserService22(UserService userService) {
		this.userService22 = userService;
	}
	public void save() {
		System.out.println("UserControler save!");
		userService22.save();
	}

}

修改配置文件为自动装配

<?xml version="1.0" encoding="UTF-8" ?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
        https://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        https://www.springframework.org/schema/context/spring-context.xsd" >
        
	<!-- 使用自动装配  -->
	<bean id="userDao2" class="com.johnny.annotation.dao.imp.UserDaoImpl"  />
	<bean id="userService22" class="com.johnny.annotation.service.imp.UserServiceImp"  autowire ="byName"/>
	<bean id="userController" class="com.johnny.annotation.controller.UserController" autowire ="byName"/>

</beans>

在默认情况下，配置文件需要通过ref来装配Bean，但设置了autowire="buName"之后，Spring会自动寻找userService Bean中的属性，并将其属性名称（UserService类属性名 UserDao userDao2）== 配置文件中Bean id（id =userDao2的Bean）进行匹配。由于UserServiceImpl 中定义了userDao2属性及其setter方法，所以SP日国内会自动地将id为userDao2的Bean装配到id为UserService22的Bean中。
同理UserController的配置也是如此。

byType：会自动寻找其他配置文件中是否有其他Bean的类型（class）与该 Bean 的ref属性的类型一致。注意：此种方式的必须满足当前IOC容器中，只有一个Bean满足条件。
constructor：会自动寻找其他配置文件中是否有其他Bean的类型（class）与该 Bean 的构造方法参数的类型一致，本质是通过byType。
可以在头文件中，一次性将该IOC容器的所有bean同一设置成自动装配：

<beans xmlns=“http://www.springframework.org/schema/beans” ……default-autowire=“byName”>

自动装配的原理基于： 约定优于配置

以上是关于Spring自动装配（基于注解）的主要内容，如果未能解决你的问题，请参考以下文章

Spring自动装配（基于注解）

Spring框架bean的配置：基于注解的配置，Autowired 自动装配 Bean，泛型依赖注入

spring-装配

spring的装配

Spring处理自动装配的歧义性

spring作用spring注解管理对象的作用域与生命周期自动装配