Spring入门-基本注解的使用

前面创建和管理对象使用xml配置文件来完成，但是随着对象的增多，xml配置文件也越来越大，为了防止这种现象的发生，注解的使用就应运而生。注解是在类或方法前面添加特定以"@+注解名"开头的标识，实现xml配置文件的功能，如前面学习的创建对象、配置作用域、配置延迟加载等功能等。

组件扫描

容器会扫描指定的包及子包下面所有的类，如果该类前面有特定的注解，比如@Component，则容器会将其纳入管理，不需要在xml中配置bean，其作用相当于在配置文件中配置一个bean元素，bean的id是带注解@Component的类的第一个字母小写后的名称。

组件扫描的使用方法：

step1 在类面前添加特定的注解，比如@Component，默认的id是类名首字母小写后的名称

step2 在我们的配置文件当中，配置组件扫描

<context:component-scan base-package="package_name"/> <!--其中package_name代表我们要扫描的包-->

只有在组件类定义前面有如下注解标记时，才会扫描到Spring容器来管理，为后续使用其他注解提供必要条件。

@Component 通用注释，spring框架的，Rod Johnson大神写的

@Named 通用注释，SUN公司的，模仿Spring的注释，现在很少用，需要导额外的包

@Repository 持久化层组件注解，一般用于访问数据库

@Service 业务层组件注解，用于业务逻辑处理  

@Controller 控制层组件注解

基本注解使用

后期做项目时，如果是控制层的类需加注解@Controller，如果是业务层的类需加@Service，如果是持久层的类需加@Repository，其他类使用@Component来添加。这里测试都是使用@Component来完成。

前期准备工作，是配置组件扫描，扫描我的测试包com.boe。

        <!-- 配置组件扫描 -->    
        <context:component-scan base-package="com.boe"></context:component-scan>

（1）创建对象、作用域、延迟加载、生命周期使用注解

创建一个People类来使用注解。

package com.boe;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import org.springframework.context.annotation.Lazy;
import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

@Component("p")
@Scope("singleton")
@Lazy(false) 
public class People {
    //默认构造方法
    public People() {
        System.out.println("创建一个人");
    }
    
    //初始化方法和销毁方法的注解，需导入tomcat
    @PostConstruct 
    public void init() {
        System.out.println("初始化了");
    }
    @PreDestroy
    public void destroy() {
        System.out.println("销毁了");
    }    
}

junit测试

    //测试@Component、作用域、延迟加载和生命周期
    @Test
    public void test1() {
        String path="myIOC.xml";
        AbstractApplicationContext ac=new ClassPathXmlApplicationContext(path);
        People people=ac.getBean("p",People.class);
        System.out.println(people);
        ac.close();
    }

测试结果

可以看出通过注解就可以创建对象，如图是在作用域为singleton，延迟加载为false的情况下结果，其跟前面使用xml配置文件的效果是一样的。需要注意的是配置销毁方法只对singleton有效。

（2）使用@Autowired和@Qualifier依赖注入

这种方法适用于set方法和构造器方法注入，注解的位置可以写在属性前面，也可以写在set或构造器方法前面，区别就是前者只能注入，后者是可以在set或构造器方法里添加其他的逻辑。默认情况下是byType类型注入，如果要指定名字需要配合@Qualifier("name")来使用。

案例通过将people注入到国家类和省类对象中来完成。

case1 set方法注入，将people注入到country

Country类

package com.boe;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

@Component
public class Country {
    //属性
    private People people;
    //get set方法
    public People getPeople() {
        return people;
    }
    @Autowired
    public void setPeople(@Qualifier("p")People people) {
        this.people = people;
    }
    //构造方法
    public Country() {
        System.out.println("创建一个新的国家");
    }
    //重写toString方法
    @Override
    public String toString() {
        return "Country [people=" + people + "]";
    }
}

junit测试

    //测试使用@Autowired和@Qualifier注解-set方法注入
    @Test
    public void test2() {
        String path="myIOC.xml";
        ApplicationContext ac=new ClassPathXmlApplicationContext(path);
        Country c=ac.getBean("country",Country.class);
        System.out.println(c);
    }

测试结果

case2 构造器注入，将people注入到province

Province类

package com.boe;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

@Component
public class Province {
    //属性
    private People people;
    //带参数构造方法
    @Autowired
    public Province(@Qualifier("p")People people) {
        System.out.println("新建一个省，有人民");
        this.people = people;
    }
    //默认构造方法
    public Province() {
        System.out.println("新建一个省，没有人民");
    }
    //重写toString
    @Override
    public String toString() {
        return "Province [people=" + people + "]";
    }    
}

junit测试

    //测试使用@Autowired和@Qualifier注解-构造方法注入
    @Test
    public void test3() {
        String path="myIOC.xml";
        ApplicationContext ac=new ClassPathXmlApplicationContext(path);
        Province province=ac.getBean("province",Province.class);
        System.out.println(province);
    }

测试结果

（3）使用@Resource依赖注入 

这种注解只适合set方法注入，并且默认情况下是byName类型，如果@Resource(name="")里没有添加名字或name找不到，则按照byType方式。

案例通过将people注入到县类对象中来完成。

Village类

package com.boe;

import javax.annotation.Resource;

import org.springframework.stereotype.Component;

@Component
public class Village {
    //属性
    private People people;
    //set方法
    @Resource(name="p")
    public void setPeople(People people) {
        this.people = people;
    }
    //构造方法
    public Village() {
        System.out.println("新建了一个村");
    }
    //重写
    @Override
    public String toString() {
        return "Village [people=" + people + "]";
    }    
}

junit测试

    //测试使用@Resource-set方法注入
    @Test
    public void test4() {
        String path="myIOC.xml";
        ApplicationContext ac=new ClassPathXmlApplicationContext(path);
        Village v=ac.getBean("village",Village.class);
        System.out.println(v);
    }

测试结果

（3）使用@Value注入值

使用@Value注解，配合spring表达式的使用，可以将值注入到对象。

UserBean类

package com.boe;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component("user")
public class UserBean {
    @Value("clyang") //name赋值为clyang
    //@Value("")也可以用在set方法前，区别就是属性前使用只能赋值，如果set方法前写除了赋值外还可以写其他的功能
    private String name;
    //读取properties属性文件
    @Value("#{config.pageSize}") //使用spring表达式
    private String pageSize;
    
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPageSize() {
        return pageSize;
    }
    public void setPageSize(String pageSize) {
        this.pageSize = pageSize;
    }
    @Override
    public String toString() {
        return "UserBean [name=" + name + ", pageSize=" + pageSize + "]";
    }
}

xml配置文件中添加对properties文件的读取

<!-- 读取properties属性文件 -->
<util:properties id="config" location="classpath:config.properties"></util:properties>

junit测试

    //测试用@Value注解，注入值（基本数据类型或者集合）
    @Test
    public void test5() {
        //路径配置文件
        String path="myIOC.xml";
        //启动spring容器，使用AbstractApplicationContext子接口
        ApplicationContext ac=new ClassPathXmlApplicationContext(path);
        //得到userBean
        UserBean ub=ac.getBean("user", UserBean.class);
        System.out.println(ub);        
    }

测试结果

结论

（1）使用注解可以减少xml配置文件中的内容，并且可以实现跟xml一样的功能，原则是能使用注解的尽量使用注解，不能使用的就使用配置文件完成。

（2）@Resource默认采用byName类型注入，@Autowired默认采用byType，如果要改byName需配合@Qualifier一起使用

（3）@Resource来自JaveEE，需要有包annotation，@Autowired和@Qualifier来自Spring，参考下图

参考博文

（1）https://www.cnblogs.com/youngchaolin/p/11332783.html

（2）https://www.cnblogs.com/Jason-Xiang/p/5345342.html