RuoYi-Vue 源码中的 Spring IoC 与 DI(两个实例)

0 阅读4分钟

若依的公告控制器里,noticeService 字段只有一行声明,为什么收到请求时就能直接用?MyBatis 配置方法收到的 DataSource 又来自哪里?下面沿着 RuoYi-Vue 3.9.2 的实际代码,分别看 Spring 在哪里创建对象、把对象交给谁,以及对象最后做了什么。

一、Spring 环境如何启动

RuoYiApplication 中的启动注解和 main 方法

ruoyi-admin · com.ruoyi.RuoYiApplication 第 12–18 行

  • @SpringBootApplication 将入口类作为 Spring Boot 配置源,启用自动配置和组件扫描。入口类位于 com.ruoyi,默认从这个包向下扫描,因此可以发现公告控制器、公告服务和数据源配置类。
  • SpringApplication.run(RuoYiApplication.class, args) 创建并刷新 Spring 应用上下文。Spring 在上下文初始化过程中注册 Bean 定义,并在创建 Bean 时解析、注入依赖。
  • exclude = { DataSourceAutoConfiguration.class } 排除了 Spring Boot 的 JDBC 数据源自动配置。若依在第二个例子中用自己的 DruidConfig 装配数据源。Spring Boot 入口注解文档

IoC(控制反转) 关注谁负责创建和管理对象。DI(依赖注入) 关注容器里的对象如何交到使用它的代码手中。

二、实例一 通知公告服务

1. 用 @Service 注册公告服务(IoC)

SysNoticeServiceImpl 实现业务接口并声明 Mapper 依赖

ruoyi-system · SysNoticeServiceImpl.java 第 15–19 行

SysNoticeServiceImpl 是若依编写的业务类,实现了 ISysNoticeService。类上的 @Service 是业务层使用的 @Component 派生注解。Spring 扫描到它后注册 Bean 定义,默认 Bean 名是 sysNoticeServiceImpl,并由容器负责创建实例。Spring 组件扫描文档

2. 用 @Autowired 注入服务(DI)

SysNoticeController 用 Autowired 注入 ISysNoticeService

ruoyi-admin · SysNoticeController.java 第 31–36 行

@RestController 使 SysNoticeController 成为 Spring 管理的 MVC 控制器,方法的返回值会写入响应体。@Autowired 将 noticeService 标为注入点。Spring 按字段声明的 ISysNoticeService 类型查找候选 Bean,本例中匹配到 SysNoticeServiceImpl,于是把它注入这个字段。Spring 的 @Autowired 文档

服务类同样通过 @Autowired 得到 noticeMapper。ApplicationConfig 上的 @MapperScan("com.ruoyi.**.mapper") 让 MyBatis-Spring 为 SysNoticeMapper 接口注册可注入的 Mapper 代理。MyBatis-Spring 的 Mapper 扫描文档

3. 查询通知公告列表

SysNoticeController 的列表方法调用已注入的 noticeService

ruoyi-admin · SysNoticeController.java 第 44–51 行

类上的 @RequestMapping("/system/notice") 与方法上的 @GetMapping("/list") 合成 GET /system/notice/list。请求通过 @PreAuthorize 的 system:notice:list 权限检查后,list() 先调用 startPage(),再调用已经注入的 noticeService.selectNoticeList(notice)。

SysNoticeServiceImpl.selectNoticeList() 接着执行 return noticeMapper.selectNoticeList(notice);。MyBatis 按 SysNoticeMapper.xml 中同名语句查询 sys_notice,控制器最后用 getDataTable(list) 将结果和总条数封装为 TableDataInfo。

三、实例二 动态数据源

1. 用 @Configuration 和 @Bean 注册动态数据源(IoC)

DruidConfig 配置类和主数据源工厂方法

ruoyi-framework · DruidConfig.java 第 32–41 行

@Configuration 把 DruidConfig 声明为配置类。Spring 调用 masterDataSource() 工厂方法创建主数据源,默认使用方法名作 Bean 名。@ConfigurationProperties("spring.datasource.druid.master") 将对应前缀的属性绑定到返回的数据源。从数据源由 slaveDataSource() 声明,配置 spring.datasource.druid.slave.enabled=true 时才注册。

DruidConfig 注册名为 dynamicDataSource 的自定义对象

ruoyi-framework · DruidConfig.java 第 52–60 行

Spring 为 dataSource(DataSource masterDataSource) 提供主数据源。方法体填入 MASTER,在从数据源 Bean 存在时加入 SLAVE,随后执行 new DynamicDataSource(masterDataSource, targetDataSources)。DynamicDataSource 是若依编写的类。@Bean(name = "dynamicDataSource") 将工厂方法的返回对象交给 Spring 管理,并显式指定 Bean 名。Spring 的 @Bean 文档

2. 把动态数据源注入 MyBatis(DI)

MyBatisConfig 通过工厂方法参数接收数据源并交给会话工厂

ruoyi-framework · MyBatisConfig.java 第 116–131 行

Spring 调用 @Bean 方法 sqlSessionFactory(DataSource dataSource) 前,会先解析它的参数。DynamicDataSource 通过父类实现了 DataSource 接口。主数据源和动态数据源都符合此参数的类型,动态数据源上的 @Primary 使它成为这个单值注入点的首选。方法体用 sessionFactory.setDataSource(dataSource) 将其交给 MyBatis,并将构建出的 SqlSessionFactory 注册为 Bean。Spring 的 @Primary 文档

按课件第 24 页的写法,可以在由 Spring 管理的类中用 @Resource 注入同一个 Bean。下面两行用于对照课件,若依源码中的注入点见上图的 sqlSessionFactory() 参数。

@Resource(name = "dynamicDataSource")
private DataSource dataSource;

name 对应 @Bean(name = "dynamicDataSource") 声明的 Bean 名。Spring 用这个名字找到类型兼容的对象,并赋给字段。Spring 的 @Resource 文档

3. 为 Mapper 查询取得数据库连接

DynamicDataSource 设置默认数据源并读取当前路由键

ruoyi-framework · DynamicDataSource.java 第 12–26 行

MyBatis 执行 Mapper 查询、需要获取连接时,DynamicDataSource 按 determineCurrentLookupKey() 取得的当前线程路由键选择目标数据源。当前线程没有设置路由键时,使用构造方法传给 setDefaultTargetDataSource() 的主数据源。第一个例子的公告查询也沿着 SysNoticeMapper、SqlSessionFactory 和这个路由数据源访问数据库。

课件参考《L09 注解》第 24–27 页和第 30 页。