一.注解驱动的意义
什么是注解驱动
- 注解启动时使用注解的形式替代xml配置,将繁杂的spring配置文件从工程中彻底消除掉,简化书写
注解驱动的弊端
- 为了达成注解驱动的目的,可能会将原先很简单的书写,变的更加复杂
- XML中配置第三方开发的资源是很方便的,但使用注解驱动无法在第三方开发的资源中进行编辑,因此会增大开发工作量
二.常用注解
启动注解功能
- 启动注解扫描,加载类中配置的注解项
<context:component-scan base-package="packageName"/>
- 说明:
- 在进行包所扫描时,会对配置的包及其子包中所有文件进行扫描
- 扫描过程是以文件夹递归迭代的形式进行的
- 扫描过程仅读取合法的java文件
- 扫描时仅读取spring可识别的注解
- 扫描结束后会将可识别的有效注解转化为spring对应的资源加入IoC容器
- 注意:
- 无论是注解格式还是XML配置格式,最终都是将资源加载到IoC容器中,差别仅仅是数据读取方式不同
- 从加载效率上来说注解优于XML配置文件
bean的定义
- 名称:@Component @Controller @Service @Repository
- 类型:类注解
- 位置:类定义上方
- 作用:设置该类为spring管理的bean
- 范例:
@Component
public class ClassName{}
- 说明:
- @Controller、@Service 、@Repository是@Component的衍生注解,功能同@Component
- 相关属性
- value(默认):定义bean的访问id
bean的作用域
- 名称:@Scope
- 类型:类注解
- 位置:类定义上方
- 作用:设置该类作为bean对应的scope属性
- 范例:
@Scope
public class ClassName{}
- 相关属性
- value(默认):定义bean的作用域,默认为singleton
bean的生命周期
- 名称:@PostConstruct、@PreDestroy
- 类型:方法注解
- 位置:方法定义上方
- 作用:设置该类作为bean对应的生命周期方法
- 范例:
@PostConstruct
public void init() { System.out.println("init..."); }
加载第三方资源
- 名称:@Bean
- 类型:方法注解
- 位置:方法定义上方
- 作用:设置该方法的返回值作为spring管理的bean
- 范例:
@Bean("dataSource")
public DruidDataSource createDataSource() { return ……; }
- 说明:
- 因为第三方bean无法在其源码上进行修改,使用@Bean解决第三方bean的引入问题
- 该注解用于替代XML配置中的静态工厂与实例工厂创建bean,不区分方法是否为静态或非静态
- @Bean所在的类必须被spring扫描加载,否则该注解无法生效
- 相关属性
- value(默认):定义bean的访问id
bean的非引用类型属性注入
- 名称:@Value
- 类型:属性注解、方法注解
- 位置:属性定义上方,方法定义上方
- 作用:设置对应属性的值或对方法进行传参
- 范例:
@Value("${jdbc.username}")
private String username;
- 说明:
- value值仅支持非引用类型数据,赋值时对方法的所有参数全部赋值
- value值支持读取properties文件中的属性值,通过类属性将properties中数据传入类中
- value值支持SpEL
- @value注解如果添加在属性上方,可以省略set方法(set方法的目的是为属性赋值)
- 相关属性
- value(默认):定义对应的属性值或参数值
bean的引用类型属性注入
- 名称:@Autowired、@Qualifier
- 类型:属性注解、方法注解
- 位置:属性定义上方,方法定义上方
- 作用:设置对应属性的对象或对方法进行引用类型传参
- 范例:
@Autowired(required = false)
@Qualifier("userDao")
private UserDao userDao;
- 说明:
- @Autowired默认按类型装配,指定@Qualifier后可以指定自动装配的bean的id
- 相关属性
- required:定义该属性是否允许为null
bean的引用类型属性注入二
- 名称:@Primary
- 类型:类注解
- 位置:类定义上方
- 作用:设置类对应的bean按类型装配时优先装配
- 范例:
@Primary
public class ClassName{}
- 说明:
- @Autowired默认按类型装配,当出现相同类型的bean,使用@Primary提高按类型自动装配的优先级,多个@Primary会导致优先级设置无效
bean的引用类型属性注入三
- 名称:@Inject、@Named、@Resource
- 说明:
- @Inject与@Named是JSR330规范中的注解,功能与@Autowired和@Qualifier完全相同,适用于不同架构场景
- @Resource是JSR250规范中的注解,可以简化书写格式
- @Resource相关属性
- name:设置注入的bean的id
- type:设置注入的bean的类型,接收的参数为Class类型
加载properties文件
- 名称:@PropertySource
- 类型:类注解
- 位置:类定义上方
- 作用:加载properties文件中的属性值
- 范例:
@PropertySource(value = "classpath:filename.properties")
public class ClassName {
@Value("${propertiesAttributeName}")
private String attributeName;
}
- 说明:
- 不支持*通配格式,一旦加载,所有spring控制的bean中均可使用对应属性值
- 相关属性
- value(默认):设置加载的properties文件名
- ignoreResourceNotFound:如果资源未找到,是否忽略,默认为false
纯注解格式
- 名称:@Configuration、@ComponentScan
- 类型:类注解
- 位置:类定义上方
- 作用:设置当前类为spring核心配置加载类
- 范例:
@Configuration
@ComponentScan("scanPackageName")
public class SpringConfigClassName{
}
- 说明:
- 核心配合类用于替换spring核心配置文件,此类可以设置空的,不设置变量与属性
- bean扫描工作使用注解@ComponentScan替代
AnnotationConfigApplicationContext
- 加载纯注解格式上下文对象,需要使用AnnotationConfigApplicationContext
ApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
第三方bean配置与管理
- 名称:@Import
- 类型:类注解
- 位置:类定义上方
- 作用:导入第三方bean作为spring控制的资源
- 范例:
@Configuration
@Import(OtherClassName.class)
public class ClassName {
}
- 说明:
- @Import注解在同一个类上,仅允许添加一次,如果需要导入多个,使用数组的形式进行设定
- 在被导入的类中可以继续使用@Import导入其他资源(了解)
- @Bean所在的类可以使用导入的形式进入spring容器,无需声明为bean
三.bean加载控制
依赖加载
- 名称:@DependsOn
- 类型:类注解、方法注解
- 位置:bean定义的位置(类上或方法上)
- 作用:控制bean的加载顺序,使其在指定bean加载完毕后再加载
- 范例:
@DependsOn("beanId")
public class ClassName {
}
- 说明:
- 配置在方法上,使@DependsOn指定的bean优先于@Bean配置的bean进行加载
- 配置在类上,使@DependsOn指定的bean优先于当前类中所有@Bean配置的bean进行加载
- 配置在类上,使@DependsOn指定的bean优先于@Component等配置的bean进行加载
- 相关属性
- value(默认):设置当前bean所依赖的bean的id
依赖加载二
- 名称:@Order
- 类型:配置类注解
- 位置:配置类定义的位置(类上)
- 作用:控制配置类的加载顺序
- 范例:
@Order(1)
public class SpringConfigClassName {
}
- 说明:
- 数值越小优先加载,-1为最高级
依赖加载三
- 名称:@Lazy
- 类型:类注解、方法注解
- 位置:bean定义的位置(类上或方法上)
- 作用:控制bean的加载时机,使其延迟加载
- 范例:
@Lazy
public class ClassName {
}
依赖加载应用场景
- @DependsOn
- 微信订阅号,发布消息和订阅消息的bean的加载顺序控制
- 双11活动期间,零点前是结算策略A,零点后是结算策略B,策略B操作的数据为促销数据。策略B加载顺序与促销数据的加载顺序
- @Lazy
- 程序灾难出现后对应的应急预案处理是启动容器时加载时机
- @Order
- 多个种类的配置出现后,优先加载系统级的,然后加载业务级的,避免细粒度的加载控制
四.注解整合第三方技术
注解整合MyBatis
注解整合MyBatis分析
- 业务类使用注解形式声明bean,属性采用注解注入
- 建立独立的配置管理类,分类管理外部资源,根据功能进行分类,并提供对应的方法获取bean
- 使用注解形式启动bean扫描,加载所有注解配置的资源(bean)
- 使用AnnotationConfigApplicationContext对象加载所有的启动配置类,内部使用导入方式进行关联
注解整合MyBatis步骤
- 修改mybatis外部配置文件格式为注解格式
- 业务类使用@Component声明bean,使用@Autowired注入对象
- 建立配置文件JDBCConfig与MyBatisConfig类,并将其导入到核心配置类SpringConfig
- 开启注解扫描
- 使用AnnotationConfigApplicationContext对象加载配置项
注解整合MyBatis代码实现
- Dao层
package com.itheima.dao;
import com.itheima.domain.Account;
import org.apache.ibatis.annotations.Delete;
import org.apache.ibatis.annotations.Insert;
import org.apache.ibatis.annotations.Select;
import org.apache.ibatis.annotations.Update;
import org.mybatis.spring.SqlSessionFactoryBean;
import java.util.List;
public interface AccountDao {
@Insert("insert into account(name,money)values(#{name},#{money})")
void save(Account account);
@Delete("delete from account where id = #{id} ")
void delete(Integer id);
@Update("update account set name = #{name} , money = #{money} where id = #{id} ")
void update(Account account);
@Select("select * from account")
List<Account> findAll();
@Select("select * from account where id = #{id} ")
Account findById(Integer id);
}
- Service层
package com.itheima.service.Impl;
import com.itheima.dao.AccountDao;
import com.itheima.domain.Account;
import com.itheima.service.AccountService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import java.util.List;
@Service("accountService")
public class AccountServiceImpl implements AccountService {
@Autowired
private AccountDao accountDao;
public void setAccountDao(AccountDao accountDao) {
this.accountDao = accountDao;
}
public void save(Account account) {
accountDao.save(account);
}
public void update(Account account){
accountDao.update(account);
}
public void delete(Integer id) {
accountDao.delete(id);
}
public Account findById(Integer id) {
return accountDao.findById(id);
}
public List<Account> findAll() {
return accountDao.findAll();
}
}
注意 : 这里的@Autowired 在某些低版本IDEA中会有红波浪显示, 不用管,可以直接运行
- JDBCConfig
package com.itheima.config;
import com.alibaba.druid.pool.DruidDataSource;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import javax.sql.DataSource;
public class JDBCConfig {
@Value("${jdbc.driver}")
private String driver;
@Value("${jdbc.url}")
private String url;
@Value("${jdbc.username}")
private String userName;
@Value("${jdbc.password}")
private String password;
@Bean("dataSource")
public DataSource getDataSource(){
DruidDataSource ds = new DruidDataSource();
ds.setDriverClassName(driver);
ds.setUrl(url);
ds.setUsername(userName);
ds.setPassword(password);
return ds;
}
}
- MyBatisConfig
package com.itheima.config;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.mapper.MapperScannerConfigurer;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import javax.sql.DataSource;
public class MybatisConfig {
//设置Mapper映射文件返回值别名以及获取DataSource
//别名为实体类对象开头子母小写
@Bean
public SqlSessionFactoryBean getSqlSessionFactoryBean(@Autowired DataSource dataSource){
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setTypeAliasesPackage("com.itheima.domain");//起别名
sqlSessionFactoryBean.setDataSource(dataSource);
return sqlSessionFactoryBean;
}
//动态代理
@Bean
public MapperScannerConfigurer getMapperScannerConfigurer(){
MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
mapperScannerConfigurer.setBasePackage("com.itheima.dao");//扫描整个Dao包下的接口
return mapperScannerConfigurer;
}
}
- SpringConfig // 主配置类,导入其他从配置类
package com.itheima.config;
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
//扫描包下的注解标识解析
@ComponentScan("com.itheima")
@PropertySource("classpath:jdbc.properties")
@Import({JDBCConfig.class,MybatisConfig.class})
public class SpringConfig02 {
}
- 测试类 //暂时使用main方法测试
import com.itheima.config.SpringConfig;
import com.itheima.domain.Account;
import com.itheima.domain.Student;
import com.itheima.service.AccountService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import javax.sql.DataSource;
public class App {
public static void main(String[] args) {
ApplicationContext alc = new AnnotationConfigApplicationContext(SpringConfig.class);
AccountService bean = (AccountService) alc.getBean("accountService");
System.out.println(bean.findAll());
}
}
注意 : 这里省略三层架构其他接口以及实体类
注解整合Junit
注解整合Junit实现步骤
- 导入Spring整合Junit坐标
- Spring整合Junit测试用例注解格式
注解整合Junit代码实现
package com.itheima.service;
import com.itheima.config.SpringConfig;
import com.itheima.domain.Account;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import java.util.List;
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = SpringConfig.class)
public class AccountTest {
@Autowired
private AccountService accountService;
@Test
public void testAccountService(){
List<Account> all = accountService.findAll();
System.out.println(all);
System.out.println(accountService.findById(1));
}
}