几分钟带你掌握Spring的那些注解使用

举报
我是一棵卷心菜 发表于 2022/01/21 13:26:57 2022/01/21
【摘要】 学习笔记

一、前言

这是spring专栏的第三篇文章,是关于spring的注解开发,包括完全注解和非完全注解开发。自己整理了学习的笔记,希望大家喜欢。

二、基本介绍

前面两篇关于spring的知识点学习,我都是用xml配置文件来一步步讲解的,但是Spring是轻代码而重配置的框架,xml配置文件比较繁重,影响开发效率,所以注解开发是一种趋势,注解代替xml配置文件可以简化配置,提高开发效率。
因此,我在写这篇文章之前,一直在思考,如何用一种方式来让小伙伴们理解的更加深刻呢?最后决定,我在讲解注解使用的时候,要与使用xml配置文件的方式进行一个对比,尽量让小伙伴们知其所以然!

三、非全注解开发

1、第一组注解

这组注解关于对象的实例化创建,在功能上都没有区别

@Component 使用在类上用于实例化Bean
@Controller 使用在web层类上用于实例化Bean
@Service 使用在service层类上用于实例化Bean
@Repository 使用在dao层类上用于实例化Bean

接下来让我们从具体的代码分析,理解和掌握它们吧!

先创建一个UserDao接口,随便写一个sayHello()方法

public interface UserDao {
    void sayHello();
}

然后写一个接口实现类UserDaoImpl类,实现接口的方法,输出“大家好,我是卷心菜~~”

//<bean id="userDao" class="com.sht.dao.impl.UserDaoImpl"></bean>
@Repository(value = "userDao")
public class UserDaoImpl implements UserDao {
    @Override
    public void sayHello() {
        System.out.println("大家好,我是卷心菜~~");
    }
}

分析: 在类上加上@Repository(value = "userDao")就表示把这个类的实例放进了spring容器中,value = "userDao"就相当于<bean id="userDao" class="com.sht.dao.impl.UserDaoImpl"></bean>中的id属性值,我们使用注解的时候,就不需要在指定类的包路径了,因此省略了class属性值

注意,使用非全注解开发,意味着要配置spring文件,与之前不同的是,我们要在配置文件中加上一个包扫描,才能让注解生效

<?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">
    <!--扫描包及其子包-->    
    <context:component-scan base-package="com.sht"/>
</beans>

写一个测试代码:

@Test
    public void test4() {
        ApplicationContext applicationContext =
                new ClassPathXmlApplicationContext("applicationContext.xml");
        UserService userService = applicationContext.getBean(UserService.class);
        userService.sayHello();
    }

运行结果:
在这里插入图片描述

2、第二组注解

这一组注解的功能是属性注入,让我们写一个代码看看他们的使用方法

@Autowired
@Resource
@Qulifier:和@Autowired一起使用

创建一个接口UserService,写一个方法sayHello()

public interface UserService {
    void sayHello();
}

创建一个接口实现类,实现其方法,我们在方法中调用UserDaoImpl类的方法,代码如下:

//<bean id="userService"  class="com.sht.service.impl.UserServiceImpl"></bean>
@Service(value = "userService")
public class UserServiceImpl implements UserService {
//    <property name="userDao" ref="userDao"></property>
    @Autowired
    @Qualifier(value = "userDao")
    private UserDao userDao;
    //可以省略不写
//    public void setUserDao(UserDao userDao) {
//        this.userDao = userDao;
//    }
    @Override
    public void sayHello() {
        userDao.sayHello();
    }
}

分析: 注解@Service(value = "userService")就不多说了,使用方法跟第一组注解相同,我们在类中引入了private UserDao userDao;,该如何注入属性呢?可以使用@Autowired+@Qualifier(value = “userDao”),其中的value属性值相当于<property name="userDao" ref="userDao"></property>中的ref属性值,可以开心的是,使用xml配置文件的方式,我们还要写属性对应的set方法,但是使用了注解后,就不需要写set方法了,是不是很方便呢?@Autowired+@Qualifier(value = “userDao”)这两个注解可以替换为@Resource(name=“userDao”),但是不建议使用;@Autowired+@Qualifier(value = “userDao”)还可以替换为单独的@Autowired,表示的是根据类型注入属性,当有多个相同类型时,就会报错,谨慎使用哦

3、第三组注解

这一组注解的功能是字符串的注入,但是不单单是普通的字符串注入,让我们写一个代码看看它的使用方法

@Value:进行字符串的注入
@PropertySource:引入外部properties文件
@Bean:将方法的返回值注入spring容器中

UserServiceImp类中加入一下代码,使用@Value注解注入自己需要的字符串内容

@Value("我是一棵卷心菜")
    private String name;
    public void print() {
        System.out.println(name);
    }

写一个测试代码,检验效果:

  @Test
    public void test4() {
        ApplicationContext applicationContext =
                new ClassPathXmlApplicationContext("applicationContext.xml");
        UserServiceImpl userService = applicationContext.getBean(UserServiceImpl.class);
        userService.print();
    }

运行结果:
在这里插入图片描述
这只是@Value注解的一种使用方法,接下来看看它的另一种使用方式

首先配置一个xml文件,用来配置Druid数据源,连接MySQL数据库,这里的内容在我的Spring专栏中讲解的非常清楚,不懂的小伙伴们可以去学习一下

<?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">
        
    <context:property-placeholder location="classpath:jdbc.properties"/>
    
    <context:component-scan base-package="com.sht"/>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
    
    <property name="driverClassName" value="${jdbc.driver}"></property>
    <property name="url" value="${jdbc.url}"></property>
    <property name="username" value="${jdbc.username}"></property>
    <property name="password" value="${jdbc.password}"></property>
    </bean>
</beans>

在resources下配置一个jdbc.properties文件

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/test
jdbc.username=root
jdbc.password=0315

接着在UserServiceImp类的上面加上注解@PropertySource(value = {"classpath:jdbc.properties"})spring配置文件中<context:property-placeholder location=“classpath:jdbc.properties”/>就可以不要了,一个注解就解决了,是不是很方便呢?
在这里插入图片描述
需要注意的是,在@PropertySource注解中,通过进入源码发现,它的属性值是一个数组类型,这就表明,我们可以引入多个properties文件

在这里插入图片描述
然后再UserServiceImp类中写一个方法,用来获取连接对象

@Value("${jdbc.driver}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean("dataSource")
    public DataSource getDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }

分析: 我们用注解@Value把properties文件的值拿到,然后在方法中进行连接配置,注解@Bean把获取的对象放进spring容器中,方便以后的使用,它的属性值是相当于bean标签里面的id

配置是否成功呢?我们来写一个测试代码:

  @Test
    public void test5() throws SQLException {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        DataSource dataSource = (DataSource) context.getBean("dataSource");
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }

运行结果:
在这里插入图片描述
到这里,我们发现spring配置文件中还多了一个包扫描,孤苦伶仃的;我们该能不能不使用配置文件呢?答案是肯定可以的,接下来就来看看完全注解开发

四、完全注解开发

1、第一组注解

这三个注解不是很重要,了解即可

@Scope:决定对象是多例还是单例
@PostConstruct:标注初始化方法
@PreDestroy:标注销毁方法
在这里插入图片描述
在这里插入图片描述

2、第二组注解

这一组注解开始打开我们全注解开发的大门

@Configuration 用于指定当前类是一个 Spring 配置类,当创建容器时会从该类上加载注解
@ComponentScan 用于指定 Spring 在初始化容器时要扫描的包。
@PropertySource 用于加载.properties 文件中的配置
@Import 用于导入其他配置类

使用全注解开发,我们首先创建一个主类SpringConfig

@Configuration
//<context:component-scan base-package="com.sht"/>
@ComponentScan(value = {"com.sht"})
public class SpringConfig {
    private int age = 18;
    public void print() {
        System.out.println("我的年龄是" + age + "岁");
    }
}

分析: @Configuration告诉spring这是一个配置类,@ComponentScan的属性值要填写包扫描的路径,它的功能跟<context:component-scan base-package="com.sht"/>一样,到了这里,我们就可以完全的不需要spring配置文件了

接下来用代码测试一下:

@Test
    public void test6() {
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        SpringConfig config = context.getBean(SpringConfig.class);
        config.print();
    }

运行结果:
在这里插入图片描述
那么问题又来了,如果我有别的配置类,如何将它们放进spring容器里面呢?这时候就需要用到@Import注解了

上面内容中,我在UserServiceImp类中写一个方法,用来获取连接对象,我现在把它们写在一个UtilGetDataSource类中,代码如下:

@PropertySource(value = {"classpath:jdbc.properties"})
public class UtilGetDataSource {
    @Value("${jdbc.driver}")
    private String driverClassName;
    @Value("${jdbc.url}")
    private String url;
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;

    @Bean("dataSource")
    public DataSource getDataSource() {
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driverClassName);
        dataSource.setUrl(url);
        dataSource.setUsername(username);
        dataSource.setPassword(password);
        return dataSource;
    }
}

我们要想使用这个方法,就需要把它放进spring容器中;用@Import注解,它的属性值也是一个数组类型的,可以引入多个类

@Import(UtilGetDataSource.class)
public class SpringConfig{ 
}

最后写个测试类看看是否正确

@Test
    public void test6() throws SQLException {
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        DataSource dataSource = (DataSource) context.getBean("dataSource");
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
    }

运行结果:
在这里插入图片描述

五、总结

spring注解开发的使用大大简化了xml的配置,注解有很多,我们应该在日常的学习中做好笔记,找时间复习,做到熟能生巧!

【版权声明】本文为华为云社区用户原创内容,转载时必须标注文章的来源(华为云社区)、文章链接、文章作者等基本信息, 否则作者和本社区有权追究责任。如果您发现本社区中有涉嫌抄袭的内容,欢迎发送邮件进行举报,并提供相关证据,一经查实,本社区将立刻删除涉嫌侵权内容,举报邮箱: cloudbbs@huaweicloud.com
  • 点赞
  • 收藏
  • 关注作者

评论(0

0/1000
抱歉,系统识别当前为高风险访问,暂不支持该操作

全部回复

上滑加载中

设置昵称

在此一键设置昵称,即可参与社区互动!

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。

*长度不超过10个汉字或20个英文字符,设置后3个月内不可修改。