Spring之旅 - 记录学习 Spring 框架的过程和经验(八)基于Spring的注解应用

前言

在现代 Java 开发中,Spring 框架凭借其强大的功能和灵活的特性,成为了构建企业级应用程序的首选框架。Spring 的注解驱动编程风格使得开发者能够以更加简洁和优雅的方式来配置和管理 Bean,为开发带来了极大的便利。通过使用注解,我们可以轻松地实现依赖注入、事务管理、AOP 等功能,而无需过多关注繁琐的 XML 配置。


Bean的基本注解开发

Spring除了xml配置文件进行配置之外,还可以使用注解方式进行配置,注解方式慢慢成为xml配置的替代方案。我们有了xml开发的经验,学习注解开发就方便了许多,注解开发更加快捷方便。Spring提供的注解有三个版本:

  • 2.0时代,Spring开始出现注解
  • 2.5时代,Spring的Bean配置可以使用注解完成
  • 3.0时代,Spring其他配置也可以使用注解完成,我们进入全注解时代

@Component的基本使用

使用@Component注解替代< bean>标签

java 复制代码
@Component(value = "userDao")
public class UserDaoImpl implements UserDao {
}

@Component 是 Spring 框架中的一个注解,用于标识一个类为 Spring 容器中的一个组件。当 Spring 扫描到这个类时,会自动创建该类的实例并将其注册为 Spring 应用上下文中的一个 Bean。

value = "userDao": 这是给该 Bean 起的名字。在其他地方注入这个 Bean 时,可以使用 "userDao" 来引用它。

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
       http://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
        ">

    <!--注解组件扫描:扫描指定的基本包及其子包下的类,去识别有没有使用@Component注解-->
    <context:component-scan base-package="com.itheima"></context:component-scan>
</beans>

测试代码:

java 复制代码
	public static void main(String[] args) {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserDao userDao = (UserDao) applicationContext.getBean("userDao");
        System.out.println(userDao);
    }

运行结果如下:

@Component就单纯一个value属性,那么xml配置时那些属性怎么进行配置呢?Spring是通过注解方式去配置的之前标签中的那些属性,例如:@Scope

java 复制代码
@Component(value = "userDao")
@Scope(value = "singleton")
@Lazy(value = false)
public class UserDaoImpl implements UserDao {

    public UserDaoImpl() {
        System.out.println("UserDao创建");
    }

    @PostConstruct
    public void init(){
        System.out.println("userDao的初始化方法");
    }
    @PreDestroy
    public void destroy(){
        System.out.println("userDao的销毁方法");
    }
}

测试代码:

java 复制代码
	public static void main(String[] args) {
        ClassPathXmlApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext.xml");
        UserDao userDao = (UserDao) applicationContext.getBean("userDao");
        applicationContext.close();
    }

运行结果如下:

由于JavaEE开发是分层的,为了每层Bean标识的注解语义化更加明确,@Component又衍生出如下三个注解:

java 复制代码
@Repository("userDao")
public class UserDaoImpl implements UserDao{}
@Service("userService")
public class UserServiceImpl implements UserService{}
@Controller("userService")
public class UserController {}

Bean的依赖注入注解开发

Bean依赖注入的注解,主要是使用注解的方式替代xml的< property>标签完成属性的注入操作

Spring主要提供如下注解,用于在Bean内部进行属性注入的:

java 复制代码
@Repository(value = "userDao")
public class UserDaoImpl implements UserDao {

    @Value("zhangsan")
    private String userName;

    @Override
    public void show() {
        System.out.println("userName:"+this.userName);
    }
}
java 复制代码
@Service("userService")
public class UserServiceImpl implements UserService {

    //根据类型进行注入,如果同一类型的Bean有多个,尝试根据名字进行二次匹配
    @Autowired
    private UserDao userDao;

    public void show(){
        System.out.println("userDao: "+userDao);
    }
}

非自定义Bean的注解开发

非自定义Bean不能像自定义Bean一样使用@Component进行管理,非自定义Bean要通过工厂的方式进行实例化使用@Bean标注方法即可,@Bean的属性为beanName,如不指定为当前工厂方法名称

java 复制代码
//将方法返回值Bean实例以@Bean注解指定的名称存储到spring容器中
@Bean ("dataSource")
public DataSource datasource() {
	DruidDataSource dataSource = new DruidDataSource();
		dataSource.setDriverClassName("com.mysql.jdbc.Driver");
		dataSource.setUrl("jdbc:mysql://localhost:3306/mybatis");
		dataSource.setUsername("root");
		dataSource.setPassword("root");
		return dataSource;
}

PS:工厂方法所在类必须要被Spring管理

如果@Bean工厂方法需要参数的话,则有如下几种注入方式:

  • 使用@Autowired根据类型自动进行Bean的匹配,@Autowired可以省略;
  • 使用@Qualifier根据名称进行Bean的匹配;
  • 使用@Value根据名称进行普通数据类型匹配。
java 复制代码
@Bean
@Autowired //根据类型匹配参数
public Object objectDemo01 (UserDao userDao){
	System.out.println (userDao);
	return new Object ();
}
@Bean
public Object objectDemo02(@Qualifier("userDao") UserDao userDao,@Value("${jdbc.username}") String username){

	System.out.println (userDao);
	System.out.println(username);
	return new Object ();
}

Bean配置类的注解开发

@Component等注解替代了< bean>标签,但是像< import>、<context.componentscan>等非< bean>标签怎样去使用注解替代呢?

xml 复制代码
<!-- 加载properties文件 -->
<context:property-placeholder location="classpath:jdbc.properties"/>
<!--组件扫描 -->
<context:component-scan base-package="com.itheima"/>
<!--引入其他xml文件 -->
<import resource="classpath:beans.xml"/>

定义一个配置类替代原有的xml配置文件,< bean>标签以外的标签,一般都是在配置类上使用注解完成的

java 复制代码
package com.itheima.config;

import com.itheima.beans.OtherBean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import org.springframework.context.annotation.PropertySource;

@Configuration //标注当前类是一个配置类(替代配置文件)+@Component

//<context:component-scan base-package="com.itheima"></context:component-scan>
@ComponentScan(basePackages = {"com.itheima"})

// <context:property-placeholder location="classpath:jdbc.properties"></context:property-placeholder>
@PropertySource("classpath:jdbc.properties")

@Import(OtherBean.class)
public class SpringConfig {

}

Spring配置其它注解

扩展:@Primary注解用于标注相同类型的Bean优先被使用权,@Primary是spring3.0引入的,与@Component和@Bean一起使用,标注该Bean的优先级更高,则在通过类型获取Bean或通过@Autowired根据类型进行注入时,会选用优先级更高的

java 复制代码
@Repository("userDao")
public class UserDaoImpl implements UserDao{}
@Repository("userDao2")
@Primary
public class UserDaoImpl2 implements UserDao{}
@Bean
public UserDao userDao01 () {return new UserDaoImpl ();}
@Bean
@Primary
public UserDao userDao02() {return new UserDaoImpl2();}

扩展:@Profile注解的作用同于xml配置时学习profile属性,是进行环境切换使用的

xml 复制代码
<beans profile="test">

注解@Profile标注在类或方法上,标注当前产生的Bean从属于哪个环境,只有激活了当前环境,被标注的Bean才能被注册到Spring容器里,不指定环境的Bean,任何环境下都能注册到Spring容器里

java 复制代码
@Repository("userDao")
@Profile("test")
public class UserDaoImpl implements UserDao{}
@Repository("userDao2")
public class UserDaoImpl2 implements UserDao{}

可以使用以下两种方式指定被激活的环境:

  • 使用命令行动态参数,虚拟机参数位置加载-Dspring.profiles.active=test
  • 使用代码的方式设置环境变量System.setProperty("spring.profiles.active","test");

Spring注解的解析原理

使用@Component等注解配置完毕后,要配置组件扫描才能使注解生效

Spring注解方式整合第三方框架

第三方框架整合,依然使用MyBatis作为整合对象,之前我们已经使用xml方式整合了MyBatis,现在使用注解方式无非就是将xml标签替换为注解,将xml配置文件替换为配置类而已,原有xml方式整合配置如下:

xml 复制代码
	<!--配置SqlSessionFactoryBean,作用将SqlSessionFactoryBean存储到spring容器-->
    <bean class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
    </bean>
    <!--MapperScannerConfigurer,作用扫描指定的包,产生mapper对象存储到Spring容器-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.itheima.mapper"></property>
    </bean>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="${jdbc.driver}"/>
        <property name="url" value="${jdbc.url}"/>
        <property name="username" value="${jdbc.username}"/>
        <property name="password" value="${jdbc.password}"/>
    </bean>
java 复制代码
@Configuration
@ComponentScan(basePackages = {"com.itheima"})
@PropertySource("classpath:jdbc.properties")
@Import(OtherBean.class)
//Mapper接口扫描
@MapperScan("com.itheima.mapper")
public class SpringConfig {

    @Bean
    public DataSource dataSource(@Value("${jdbc.driver}") String driver, @Value("${jdbc.url}")String url,
                                 @Value("${jdbc.username}")String username,@Value("${jdbc.password}") String password) {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

    @Bean
    public SqlSessionFactoryBean sqlSessionFactoryBean(DataSource dataSource) throws Exception {
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean;
    }
}
java 复制代码
public interface UserMapper {
    List<User> findAll();
}


@Service("userService")
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;

    @Override
    public void show() {
        List<User> userList = userMapper.findAll();
        for (User user : userList) {
            System.out.println(user);
        }
    }
}
xml 复制代码
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.itheima.mapper.UserMapper">
    <select id="findAll" resultType="com.itheima.pojo.User">
        select * from user
    </select>
</mapper>

测试结果如下:

注解方式,Spring整合MyBatis的原理,关键在于@MapperScan,@MapperScan不是Spring提供的注解,是MyBatis为了整合Spring,在整合包org.mybatis.spring.annotation中提供的注解,源码如下:

重点关注一下@Import((MapperScannerRegistrar.class}),当@MapperScan被扫描加载时,会解析@Import注解,从而加载指定的类,此处就是加载了MapperScannerRegistrar

Spring与MyBatis注解方式整合有个重要的技术点就是@lmport,第三方框架与Spring整合xml方式很多是凭借自定义标签完成的,而第三方框架与Spring整合注解方式很多是靠@Import注解完成的。

@lmport可以导入如下三种类:

  • 普通的配置类
  • 实现ImportSelector接口的类
  • 实现ImportBeanDefinitionRegistrar接口的类
java 复制代码
package com.itheima.imports;

import com.itheima.beans.OtherBean;
import com.itheima.beans.OtherBean2;
import org.springframework.context.annotation.ImportSelector;
import org.springframework.core.type.AnnotationMetadata;

public class MyImportSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        //annotationMetadata叫做注解媒体数据,该对象内部封装的是当前使用了@Import注解的类上的其它注解的源信息

        //返回的数组封装是需要被注册到Spring容器的Bean的全限定类名
        return new String[]{OtherBean.class.getName(), OtherBean2.class.getName()};
    }
}
java 复制代码
package com.itheima.imports;

import com.itheima.beans.OtherBean2;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.BeanNameGenerator;
import org.springframework.beans.factory.support.RootBeanDefinition;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;

public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {

    @Override
    public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry, BeanNameGenerator importBeanNameGenerator) {
        //注册BeanDefinition
        BeanDefinition beanDefinition = new RootBeanDefinition();
        beanDefinition.setBeanClassName(OtherBean2.class.getName());
        registry.registerBeanDefinition("otherBean2",beanDefinition);
    }
}

总结

在本博客中,我们学习了多个重要的注解及其应用场景,了解了如何通过自定义注解和选择器来扩展 Spring 的功能。这些内容不仅增强了我们对 Spring 框架的理解,也为我们在实际开发中提供了实用的工具和方法。

相关推荐
YJlio6 小时前
Kali Linux 外置无线网卡接入与识别排障(VMware 环境|合规学习版)
linux·网络·学习
韩明君6 小时前
debian13学习笔记
服务器·笔记·学习
工具罗某人6 小时前
docker快速部署minio
java·nginx·docker
2501_941877137 小时前
大规模系统稳定性建设方法论与工程实践分享
java·开发语言
学习在路上ing7 小时前
ollama部署模型
java·ollama
浩瀚地学7 小时前
【Java】面向对象进阶-接口
java·开发语言·经验分享·笔记·学习
沛沛老爹7 小时前
用 Web 开发思维理解 Agent 的三大支柱——Tools + Memory + LLM
java·人工智能·llm·llama·rag
ZePingPingZe7 小时前
@TransactionalEventListener:事务事件监听的艺术
分布式·spring·rabbitmq
xwz小王子7 小时前
TRO 综述:面向多模态示教机器人学习的深度生成模型
学习·机器人
组合缺一7 小时前
灵动如画 —— 初识 Solon Graph Fluent API 编排
java·solon·graph·flow·langgraph·liquor