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

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

文章目录

一、前言

二、基本介绍

三、非全注解开发

1、第一组注解

2、第二组注解

3、第三组注解

四、完全注解开发

1、第一组注解

2、第二组注解

五、总结


一、前言

这是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();
    }


运行结果:

image.png


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();
    }


运行结果:

image.png

这只是@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文件

image.png

然后再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);
    }


运行结果:

image.png

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


四、完全注解开发

1、第一组注解

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


@Scope:决定对象是多例还是单例

@PostConstruct:标注初始化方法

@PreDestroy:标注销毁方法


image.png

image.png

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();
    }


运行结果:

image.png

那么问题又来了,如果我有别的配置类,如何将它们放进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);
    }


运行结果:

image.png


五、总结

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


相关文章
|
1月前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
52 0
|
2天前
|
Java Spring
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
110 73
|
2月前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
150 3
|
2天前
|
存储 Java Spring
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
|
2天前
|
Java Spring
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
29天前
|
前端开发 Java Spring
Spring MVC核心:深入理解@RequestMapping注解
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的核心,它将HTTP请求映射到控制器的处理方法上。本文将深入探讨`@RequestMapping`注解的各个方面,包括其注解的使用方法、如何与Spring MVC的其他组件协同工作,以及在实际开发中的应用案例。
42 4
|
1月前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
68 4
SpringBoot必须掌握的常用注解!
|
29天前
|
前端开发 Java 开发者
Spring MVC中的请求映射:@RequestMapping注解深度解析
在Spring MVC框架中,`@RequestMapping`注解是实现请求映射的关键,它将HTTP请求映射到相应的处理器方法上。本文将深入探讨`@RequestMapping`注解的工作原理、使用方法以及最佳实践,为开发者提供一份详尽的技术干货。
110 2
|
29天前
|
前端开发 Java Spring
探索Spring MVC:@Controller注解的全面解析
在Spring MVC框架中,`@Controller`注解是构建Web应用程序的基石之一。它不仅简化了控制器的定义,还提供了一种优雅的方式来处理HTTP请求。本文将全面解析`@Controller`注解,包括其定义、用法、以及在Spring MVC中的作用。
50 2
|
1月前
|
消息中间件 Java 数据库
解密Spring Boot:深入理解条件装配与条件注解
Spring Boot中的条件装配与条件注解提供了强大的工具,使得应用程序可以根据不同的条件动态装配Bean,从而实现灵活的配置和管理。通过合理使用这些条件注解,开发者可以根据实际需求动态调整应用的行为,提升代码的可维护性和可扩展性。希望本文能够帮助你深入理解Spring Boot中的条件装配与条件注解,在实际开发中更好地应用这些功能。
38 2