Spring之注解开发

Spring原始注解

Spring是轻代码而重配置的框架，配置比较繁重，影响开发效率，所以注解开发是一种趋势，注解代替xml配置文件可以简化配置，提高开发效率。

Spring原始注解主要是替代xml的配置，可以参考我这篇：Spring中的bean标签详解

注意：
使用注解进行开发时，需要在applicationContext.xml中配置组件扫描，作用是指定哪个包及其子包下的Bean需要进行扫描以便识别使用注解配置的类、字段和方法。

<!--注解的组件扫描-->
<context:component-scan base-package="com.zjq"></context:component-scan>
1
2

使用@Compont或@Repository标识UserDaoImpl需要Spring进行实例化。

//@Component("userDao")
@Repository("userDao")
public class UserDaoImpl implements UserDao {
    @Override
    public void save() {
    	System.out.println("save running... ...");
    }
}
1
2
3
4
5
6
7
8

使用@Compont或@Service标识UserServiceImpl需要Spring进行实例化

使用@Autowired或者@Autowired+@Qulifier或者@Resource进行userDao的注入

//@Component("userService")
@Service("userService")
public class UserServiceImpl implements UserService {
    /*@Autowired
    @Qualifier("userDao")*/
    @Resource(name="userDao")
    private UserDao userDao;
    @Override
    public void save() {       
   	  userDao.save();
    }
}
1
2
3
4
5
6
7
8
9
10
11
12

使用@Value进行字符串的注入

@Repository("userDao")
public class UserDaoImpl implements UserDao {
    @Value("注入普通数据")
    private String str;
    @Value("${jdbc.driver}")
    private String driver;
    @Override
    public void save() {
        System.out.println(str);
        System.out.println(driver);
        System.out.println("save running... ...");
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

使用@Scope标注Bean的范围

//@Scope("prototype")
@Scope("singleton")
public class UserDaoImpl implements UserDao {
   //此处省略代码
}
1
2
3
4
5

使用@PostConstruct标注初始化方法，使用@PreDestroy标注销毁方法

@PostConstruct
public void init(){
	System.out.println("初始化方法....");
}
@PreDestroy
public void destroy(){
	System.out.println("销毁方法.....");
}
1
2
3
4
5
6
7
8

DI 依赖注⼊的注解实现⽅式

@Autowired（推荐使⽤）

@Autowired为Spring提供的注解，需要导⼊包
org.springframework.beans.factory.annotation.Autowired。
@Autowired采取的策略为按照类型注⼊。

    @Autowired
    private UserDao userDao;
1
2

如上代码所示，这样装配回去spring容器中找到类型为AccountDao的类，然后将其注⼊进来。这样会产⽣⼀个问题，当⼀个类型有多个bean值的时候，会造成⽆法选择具体注⼊哪⼀个的情况，这个时候我们需要配合着@Qualifier使⽤。

@Qualifier

@Qualifier告诉Spring具体去装配哪个对象。

    @Autowired
    @Qualifier("userDao")
    private UserDao userDao;
1
2
3

这个时候我们就可以通过类型和名称定位到我们想注⼊的对象。

@Resource

@Resource 注解由 J2EE 提供，需要导⼊包 javax.annotation.Resource。
@Resource 默认按照 ByName ⾃动注⼊。

public class TransferService {
    @Resource
    private AccountDao accountDao;
    @Resource(name="studentDao")
    private StudentDao studentDao;
    @Resource(type="TeacherDao")
    private TeacherDao teacherDao;
    @Resource(name="manDao",type="ManDao")
    private ManDao manDao;
}
1
2
3
4
5
6
7
8
9
10

• 如果同时指定了 name 和 type，则从Spring上下⽂中找到唯⼀匹配的bean进⾏装配，找不到则抛出异常。
• 如果指定了 name，则从上下⽂中查找名称（id）匹配的bean进⾏装配，找不到则抛出异常。
• 如果指定了 type，则从上下⽂中找到类似匹配的唯⼀bean进⾏装配，找不到或是找到多个，都会抛出异常。
• 如果既没有指定name，⼜没有指定type，则⾃动按照byName⽅式进⾏装配；

注意:
@Resource 在 Jdk 11中已经移除，如果要使⽤，需要单独引⼊jar包

<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.3.2</version>
</dependency>
1
2
3
4
5

Spring新注解

使用上面的注解还不能全部替代xml配置文件，还需要使用注解替代的配置如下：

非自定义的Bean的配置：

加载properties文件的配置：context:property-placeholder

组件扫描的配置：context:component-scan

引入其他文件：

@Configuration @ComponentScan @Import

在Spring框架中，@Configuration、@ComponentScan和@Import是用于配置和管理应用程序组件的注解。

@Configuration：@Configuration注解用于标记一个类作为配置类。配置类中通常包含一些用于配置应用程序的Bean定义，以及其他配置相关的方法。这个注解告诉Spring容器，该类将提供Bean定义，并且可以通过@Bean注解来创建和配置Bean。

@ComponentScan：@ComponentScan注解用于自动扫描和注册Spring组件，例如带有@Component、@Service、@Repository、@Controller等注解的类。通过指定扫描的包名或类路径，Spring将自动发现并注册这些组件作为可用的Bean。

@Import：@Import注解用于导入其他配置类或组件类到当前配置类中。通过@Import注解，可以将其他配置类或组件类引入到当前配置类中，以便共享它们的配置和功能。可以导入其他@Configuration注解标记的配置类，或者其他非配置类的普通组件。

@Configuration
@ComponentScan("com.zjq")
@Import({DataSourceConfiguration.class})
public class SpringConfiguration {
}
1
2
3
4
5

@PropertySource @value

在Spring框架中，@PropertySource和@Value是用于处理属性配置和注入的注解。

@PropertySource：@PropertySource注解用于指定属性配置文件的位置。通过在配置类上使用@PropertySource注解，您可以告诉Spring从指定的属性文件中加载属性值。属性文件可以包含应用程序中需要使用的配置属性，如数据库连接信息、日志配置等。

@Value：@Value注解用于将属性值注入到Spring管理的Bean中。通过在Bean的字段、构造函数参数、Setter方法上使用@Value注解，您可以将属性值从配置文件或其他来源动态地注入到Bean中。@Value注解支持直接注入常量值、SpEL表达式和属性占位符。
可以参考如下示例

@PropertySource("classpath:jdbc.properties")
public class DataSourceConfiguration {
    @Value("${jdbc.driver}")
    private String driver;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username:root}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
1
2
3
4
5
6
7
8
9
10

在上述示例中，@PropertySource指定了属性配置文件的位置，例如 jdbc.properties。而在配置类中，使用@Value注解将配置文件中的属性值注入到对应的字段中。${jdbc.url}表示从配置文件中读取名为jdbc.url的属性值，${jdbc.username:root}表示读取名为jdbc.username的属性值，如果属性不存在，则使用默认值root。

通过使用@PropertySource和@Value注解，您可以方便地从属性文件中读取配置属性，并将其注入到Spring的Bean中，以便在应用程序中使用。这样可以使配置更加灵活，便于管理和修改。

@Bean

@Bean注解是Spring框架中的一个关键注解，用于标记一个方法，该方法将被Spring容器管理，并且将返回一个被Spring管理的对象（Bean）。

使用@Bean注解的方法通常位于@Configuration注解标记的配置类中，用于创建和配置Bean实例。当Spring容器启动时，它会扫描配置类，并将带有@Bean注解的方法作为Bean的定义进行处理。在运行时，Spring容器将调用这些方法以获取Bean的实例。

@Bean(name="dataSource")
public DataSource getDataSource() throws PropertyVetoException { 
    ComboPooledDataSource dataSource = new ComboPooledDataSource(); 
    dataSource.setDriverClass(driver);
    dataSource.setJdbcUrl(url);
    dataSource.setUser(username);
    dataSource.setPassword(password);
    return dataSource;
}
1
2
3
4
5
6
7
8
9

测试加载核心配置类创建Spring容器

@Test
public void testAnnoConfiguration() throws Exception {
ApplicationContext applicationContext = new 
          AnnotationConfigApplicationContext(SpringConfiguration.class);    UserService userService = (UserService)    
    applicationContext.getBean("userService");
    userService.save();
    DataSource dataSource = (DataSource) 
    applicationContext.getBean("dataSource");
    Connection connection = dataSource.getConnection(); 
    System.out.println(connection);
    }
1
2
3
4
5
6
7
8
9
10
11

Spring整合Junit

原始Junit测试Spring的问题

在测试类中，每个测试方法都有以下两行代码：

 ApplicationContext ac = new ClassPathXmlApplicationContext("bean.xml");
 IAccountService as = ac.getBean("accountService",IAccountService.class);
1
2

这两行代码的作用是获取容器，如果不写的话，直接会提示空指针异常。所以又不能轻易删掉。

上述问题解决思路

让SpringJunit负责创建Spring容器，但是需要将配置文件的名称告诉它

将需要进行测试Bean直接在测试类中进行注入

Spring集成Junit步骤

①导入spring集成Junit的坐标

②使用@Runwith注解替换原来的运行期

③使用@ContextConfiguration指定配置文件或配置类

④使用@Autowired注入需要测试的对象

⑤创建测试方法进行测试

Spring集成Junit代码实现

①导入spring集成Junit的坐标

<dependency>
    <groupId>org.springframeworkgroupId>
    <artifactId>spring-testartifactId>
    <version>5.0.2.RELEASEversion>
dependency>
<dependency>
    <groupId>junitgroupId>
    <artifactId>junitartifactId>
    <version>4.12version>
    <scope>testscope>
dependency>
1
2
3
4
5
6
7
8
9
10
11
12

②使用@Runwith注解替换原来的运行期

@RunWith(SpringJUnit4ClassRunner.class)
public class SpringJunitTest {
}
1
2
3

③使用@ContextConfiguration指定配置文件或配置类

@RunWith(SpringJUnit4ClassRunner.class)
//加载spring核心配置文件
//@ContextConfiguration(value = {"classpath:applicationContext.xml"})
//加载spring核心配置类
@ContextConfiguration(classes = {SpringConfiguration.class})
public class SpringJunitTest {
}
1
2
3
4
5
6
7

④使用@Autowired注入需要测试的对象

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {SpringConfiguration.class})
public class SpringJunitTest {
    @Autowired
    private UserService userService;
}
1
2
3
4
5
6

⑤创建测试方法进行测试

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(classes = {SpringConfiguration.class})public class SpringJunitTest {
    @Autowired
    private UserService userService;
    @Test
    public void testUserService(){
   	 userService.save();
    }
}
1
2
3
4
5
6
7
8
9

本文内容到此结束了，
如有收获欢迎点赞👍收藏💖关注✔️，您的鼓励是我最大的动力。
如有错误❌疑问💬欢迎各位指出。
主页：共饮一杯无的博客汇总👨‍💻

保持热爱，奔赴下一场山海。🏃🏃🏃