Spring注解开发入门教程

itzhuzhu.

已于 2022-05-05 10:01:19 修改

阅读量1.5k

点赞数 2

分类专栏： Spring 文章标签： spring Spring注解开发

于 2021-12-25 14:48:31 首次发布

本文链接：https://blog.csdn.net/weixin_45477086/article/details/122083600

版权

Spring 专栏收录该内容

9 篇文章 2 订阅

订阅专栏

`注解开发：`

什么是驱动注解？

注解启动时使用注解的形式替代xml配置，将繁杂的spring配置文件从工程中彻底消除掉，简化书写

注解驱动的弊端

为了达成注解驱动的目的，可能会将原先很简单的书写，变的更加复杂
XML中配置第三方开发的资源是很方便的，但使用注解驱动无法在第三方开发的资源中进行编辑，因此会增大开发工作量（但是第三方资源开发中编辑的毕竟比较少，所以注解的优势依旧大于配置）

在这里插入图片描述

`启动注解功能：`

启动注解扫描，加载类中配置的注解项

<context:component-scan base-package="包名"/>

说明：

在进行包所扫描时，会对配置的包及其子包中所有文件进行扫描
扫描过程是以文件夹递归迭代的形式进行的
扫描过程仅读取合法的java文件
扫描时仅读取spring可识别的注解
扫描结束后会将可识别的有效注解转化为spring对应的资源加入IoC容器

注意：

无论是注解格式还是XML配置格式，最终都是将资源加载到IoC容器中，差别仅仅是数据读取方式不同
从加载效率上来说注解优于XML配置文件（注解找到这个类以后直接可以加载，配置文件是先找类然后加载）

`bean的定义：`

名称：@Component @Controller @Service @Repository

类型：类注解
位置：类定义上方
作用：设置该类为spring管理的bean
范例：

@Component("userService")
public class UserServiceImpl implements UserService {}

说明：

@Controller（表现层）、@Service （业务层）、@Repository（dao）是@Component的衍生注解，功能同@Component，对应三层架构，写哪个都是一样的

相关属性：

value：默认会加上value，定义时不需要写，只要写bean的访问id即可

`bean的作用域：`

名称：@Scope
类型：类注解
位置：类定义上方
作用：设置该类作为bean对应的scope属性
范例：

@Scope
@Component("userService")
public class UserServiceImpl implements UserService {}

`bean的生命周期：`

名称：@PostConstruct、@PreDestroy
类型：方法注解
位置：方法定义上方
作用：设置该类作为bean对应的生命周期方法
范例：

    @PostConstruct
    public void init() {
        System.out.println("user service init...");
    }
    @PreDestroy
    public void destroy() {
        System.out.println("user service destroy...");
    }

`加载第三方资源：`

名称：@Bean
类型：方法注解
位置：方法定义上方
作用：设置该方法的返回值作为spring管理的bean
范例：

@Component
public class JDBCConfig {
    @Bean("dataSource")
    public static DruidDataSource getDataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName("com.mysql.jdbc.Druid");
        ds.setUrl("jdbc:mysql://localhost:3306/db2");
        ds.setUsername("你的用户名");
        ds.setPassword("你的密码");
        return ds;
    }
}

说明：
- 因为第三方bean无法在其源码上进行修改，使用@Bean解决第三方bean的引入问题
- 该注解用于替代XML配置中的静态工厂与实例工厂创建bean，不区分方法是否为静态或非静态
- @Bean所在的类必须被spring扫描加载，否则该注解无法生效

相关属性：

value（默认）：定义bean的访问id

`bean的非引用类型属性注入：`

名称：@Value
类型：属性注解、方法注解
位置：属性定义上方，方法定义上方
作用：设置对应属性的值或对方法进行传参
范例：

@Component("userDao")
public class UserDaoImpl implements UserDao {

    @Value("${jdbc.username}")
    private String username;

    private int num;
    @Value("1")
    private String version;

    // 这个书写方式可以读取properties文件，也可以直接写在set方法上，但是写了value的话set方法就可以省略了
    @Value("1")
    public void setNum(int num) {
        this.num = num;
    }
}

说明：
- 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（比如有userDao1、userDao2，可以指定名称加载）
相关属性
- required：定义该属性是否允许为null

`bean的引用类型属性注入：`

名称：@Primary
类型：类注解
位置：类定义上方
作用：设置类对应的bean按类型装配时优先装配
范例：

@Component
@Primary
public class ClassName{}

说明：

@Autowired默认按类型装配，当出现相同类型的bean，使用@Primary提高按类型自动装配的优先级，多个@Primary会导致优先级设置无效
例：比如有userDao1、userDao2类，但是两个类的@Component都没写id，配置加载的是userDao，这个时候会报错说匹配不到，就可以在类上加@Primary，加在哪个类，哪个类优先加载

`bean的引用类型属性注入：`

名称：@Inject、@Named、@Resource
说明：
- @Inject与@Named是JSR330规范中的注解，功能与@Autowired和@Qualifier完全相同，适用于不同架构场景
- @Resource是JSR250规范中的注解，可以简化书写格式，说白了就是把@Autowired、@Qualifier合并成@Resource
@Resource相关属性
- name：设置注入的bean的id（就是@Autowired）
- type：设置注入的bean的类型，接收的参数为Class类型（就是@Qualifier）

`加载properties文件：`

名称：@PropertySource
类型：类注解
位置：类定义上方
作用：加载properties文件中的属性值
范例：

@PropertySource(value = "classpath:jdbc.properties")
// 如果有都个文件可以使用数组加载，加大括号，配置文件之间用逗号隔开
@PropertySource(value = {"classpath:jdbc.properties","classpath:jdbc2.properties"},ignoreResourceNotFound =  true)
public class ClassName {
    @Value("${jdbc.username}")
    private String username;
    @Value("${jdbc.password}")
    private String password;
}

说明：

不支持*通配格式，一旦加载，所有spring控制的bean中均可使用对应属性值

相关属性：

value（默认）：设置加载的properties文件名
ignoreResourceNotFound：如果资源未找到，是否忽略，默认为false

`纯注解格式：`

名称：@Configuration、@ComponentScan
类型：类注解
位置：类定义上方
作用：设置当前类为spring核心配置加载类
范例：

@Configuration   // 代替spring的配置文件
@ComponentScan("com.itzhuzhu")  // 代替xml配置文件的包扫描   <context:component-scan base-package="com.itzhuzhu"/>
public class SpringConfig{
}

AnnotationConfigApplicationContext

加载纯注解格式上下文对象，需要使用AnnotationConfigApplicationContext加载配置

    public static void main(String[] args) {
        // ApplicationContext ctx = new ClassPathXmlApplicationContext("applicationContext.xml");
        // 加载配置类的字节码
        AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);
        UserService userService = (UserService) ctx.getBean("userService");
        UserDao userDao = (UserDao) ctx.getBean("userDao");
        BookDao bookDao = (BookDao) ctx.getBean("bookDao");
        userService.save();
        userDao.save();
        bookDao.save();
	}

说明：

核心配合类用于替换spring核心配置文件，此类可以设置空的，不设置变量与属性
bean扫描工作使用注解@ComponentScan替代

`第三方bean配置与管理：`

名称：@Import
类型：类注解
位置：类定义上方
作用：导入第三方bean作为spring控制的资源
范例：

@Configuration
@Import(JDBCConfig.class) //Import只能有一个，这里是演示加载多个配置文件
@Import({JDBCConfig.class,JDBCConfig2.class})
public class ClassName {
}

// spring类配置加载后，在JDBCConfig就不需要写@Component
public class JDBCConfig {
    @Bean("dataSource")
    public static DruidDataSource getDataSource() {
        DruidDataSource ds = new DruidDataSource();
        ds.setDriverClassName("com.mysql.jdbc.Druid");
        ds.setUrl("jdbc:mysql://localhost:3306/db2");
        ds.setUsername("你的用户名");
        ds.setPassword("你的密码");
        return ds;
    }
}

说明：
- @Import注解在同一个类上，仅允许添加一次，如果需要导入多个，使用数组的形式进行设定，加大括号，用逗号隔开
- 在被导入的类中可以继续使用@Import导入其他资源
- @Bean所在的类可以使用导入的形式进入spring容器，无需声明为bean

`bean加载控制：`

@DependsOn

名称：@DependsOn
类型：类注解、方法注解
位置：bean定义的位置（类上或方法上）
作用：控制bean的加载顺序，使其在指定bean加载完毕后再加载
范例：

@Component("userDao")
@DependsOn("userService")// 表示userDao依赖userService，会先加载userService再加载userDao
public class UserDaoImpl {
}

说明：
- 配置在方法上，使@DependsOn指定的bean优先于@Bean配置的bean进行加载
- 配置在类上，使@DependsOn指定的bean优先于当前类中所有@Bean配置的bean进行加载
- 配置在类上，使@DependsOn指定的bean优先于@Component等配置的bean进行加载