首页 > 其他分享> > Spring4：使用注解开发

Spring4：使用注解开发

2021-05-10 20:04:48 作者：互联网

1、说明

在spring4之后，想要使用注解形式，必须得要引入aop的包

在配置文件当中，还得要引入一个context约束

<?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
       https://www.springframework.org/schema/beans/spring-beans.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context.xsd
       " >

</beans>

2、Bean的实现

我们之前都是使用 bean 的标签进行bean注入，但是实际开发中，我们一般都会使用注解！

测试步骤：

1、配置扫描哪些包下的注解

<!--指定注解扫描包-->
<context:component-scan base-package="org.com.pojo"/>

2、在指定包下编写类，增加注解

@Component("user")
// 相当于 <bean id = "user" class = "当前类"></bean>
public class User {
    private String name;

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                '}';
    }
}

3、属性注入

可以不用提供set方法，直接在直接名上添加@value("值")

@Value("Tim")
// 相当于  <property name="name" value="Tim"/>
private String name;

如果提供了set方法，在set方法上添加@value("值");

public String name;

@Value("Tim")
public void setName(String name) {
    this.name = name;
}

4、测试

@Test
public void test1(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    User user = context.getBean("user", User.class);
    System.out.println(user);
}

3、衍生注解

我们这些注解，就是替代了在配置文件当中配置步骤而已！更加的方便快捷！

@Component三个衍生注解

为了更好的进行分层，Spring可以使用其它三个注解，功能一样，目前使用哪一个功能都一样。

@Controller：web层
@Service：service层
@Repository：dao层

写上这些注解，就相当于将这个类交给Spring管理装配了！

4、自动装配注解

4.1、介绍

自动装配是使用spring满足bean依赖的一种方法
spring会在应用上下文中为某个bean寻找其依赖的bean。

Spring中bean有三种装配机制，分别是：

在xml中显式配置；
在java中显式配置；
隐式的bean发现机制和自动装配。

这里我们主要讲第三种：自动化的装配bean。

Spring的自动装配需要从两个角度来实现，或者说是两个操作：

组件扫描(component scanning)：spring会自动发现应用上下文中所创建的bean；
自动装配(autowiring)：spring自动满足bean之间的依赖，也就是我们说的IOC/DI；

组件扫描和自动装配组合发挥巨大威力，使得显示的配置降低到最少。

推荐不使用自动装配xml配置 , 而使用注解

4.2、搭建环境

1、创建一个新模块

2、编写实体类

public class Cat {

    public void shout(){
        System.out.println("喵喵喵~~~");
    }

}

public class Dog {

    public void shout(){
        System.out.println("汪汪汪~~~");
    }
}

public class User {
    private String name;
    private Cat cat;
    private Dog dog;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Cat getCat() {
        return cat;
    }

    public void setCat(Cat cat) {
        this.cat = cat;
    }

    public Dog getDog() {
        return dog;
    }

    public void setDog(Dog dog) {
        this.dog = dog;
    }
}

4、编写配置文件

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
       https://www.springframework.org/schema/beans/spring-beans.xsd ">

    <bean id="cat" class="org.com.pojo.Cat"/>
    <bean id="dog" class="org.com.pojo.Dog"/>

    <bean id="user" class="org.com.pojo.User">
        <property name="name" value="Tim"/>
        <property name="cat" ref="cat"/>
        <property name="dog" ref="dog"/>
    </bean>
</beans>

5、进行测试

@Test
public void test1(){
    ApplicationContext context = new ClassPathXmlApplicationContext("beans.xml");
    User user = context.getBean("user", User.class);
    user.getCat().shout();
    user.getDog().shout();

}

结果正常，环境没有问题！

4.3、byName

autowire byName (按名称自动装配)

由于在手动配置xml过程中，常常发生字母缺漏和大小写等错误，而无法对其进行检查，使得开发效率降低。

采用自动装配将避免这些错误，并且使配置简单化。

1、修改配置文件

<!--
        1.通过名字来自动装配
        2.发现user中有两个叫cat和dog的属性
        3.看看IOC容器中没有叫cat和dog的对象
        4.如果有，就装配进去
    -->
<bean id="user" class="org.com.pojo.User" autowire="byName">
    <property name="name" value="Tim"/>
</bean>

2、再次测试，正常输出

3、我们将 cat 的bean id修改为 catXX

4、再次测试，执行时报空指针java.lang.NullPointerException。因为按byName规则找不对应set方法，真正的setCat就没执行，对象就没有初始化，所以调用时就会报空指针错误。

小结：

当一个bean节点带有 autowire byName的属性时。

将查找其类中所有的set方法名，例如setCat，获得将set去掉并且首字母小写的字符串，即cat。
去spring容器中寻找是否有此字符串名称id的对象。
如果有，就取出注入；如果没有，就报空指针异常。

4.4、byType

使用autowire byType首先需要保证：同一类型的对象，在spring容器中唯一。如果不唯一，会报不唯一的异常。

NoUniqueBeanDefinitionException

1、修改配置文件

<!--
        1.通过类型来自动装配
        2.发现user中有两个叫cat和dog的属性
        3.看看IOC容器有没有Cat和Dog类型的对象
        4.如果有，就装配进去
    -->

<bean id="user" class="org.com.pojo.User" autowire="byType" >
    <property name="name" value="Tim"/>
</bean>

2、再次测试，输出正常。

3、再注册一个cat 的bean对象

<bean id="cat2" class="org.com.pojo.Cat"/>

4、重新测试，报错：NoUniqueBeanDefinitionException

5、删掉cat2，将cat的bean名称改掉！测试！因为是按类型装配，所以并不会报异常，也不影响最后的结果。甚至将id属性去掉，也不影响结果。

我们也可以设置一个xml配置文件中全局设置：

4.5、使用注解

jdk1.5开始支持注解，spring2.5开始全面支持注解。

操作步骤：

1、导入约束

xmlns:context="http://www.springframework.org/schema/context"

http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context.xsd

2、开启注解属性支持

<context:annotation-config/>

@Autowired

@Autowired是按类型自动转配的，不支持id匹配。
需要导入 spring-aop的包！

测试：

1、将User类中的set方法去掉，使用@Autowired注解

public class User {
    private String name;
    @Autowired
    private Cat cat;
    @Autowired
    private Dog dog;

    public String getName() {
        return name;
    }

    public Cat getCat() {
        return cat;
    }

    public Dog getDog() {
        return dog;
    }

}

2、配置文件

<context:annotation-config/>

<bean id="cat" class="org.com.pojo.Cat"/>
<bean id="dog" class="org.com.pojo.Dog"/>
<bean id="user" class="org.com.pojo.User"/>

3、测试，输出成功！

说明：

@Autowired(required=false) 说明：false，对象可以为null；true，对象必须存对象，不能为null。

//如果允许对象为null，设置required = false,默认为true
@Autowired(required = false)
private Cat cat;

@Qualifier

@Autowired是根据类型自动装配的，加上@Qualifier则可以根据byName的方式自动装配
@Qualifier不能单独使用。

测试步骤：

1、配置文件修改内容，保证类型存在对象。且名字不为类的默认名字！

<bean id="cat1" class="org.com.pojo.Cat"/>
<bean id="cat2" class="org.com.pojo.Cat"/>
<bean id="dog1" class="org.com.pojo.Dog"/>
<bean id="dog2" class="org.com.pojo.Dog"/>

2、没有加Qualifier测试，直接报错

3、在属性上添加Qualifier注解

@Autowired
@Qualifier("cat1")
private Cat cat;
@Autowired
@Qualifier("dog1")
private Dog dog;

4、测试，成功输出

@Resource

@Resource如有指定的name属性，先按该属性进行byName方式查找装配；
其次再进行默认的byName方式进行装配；
如果以上都不成功，则按byType的方式自动装配。
都不成功，则报异常。

测试步骤：

1、配置pom

<dependency>
    <groupId>javax.annotation</groupId>
    <artifactId>javax.annotation-api</artifactId>
    <version>1.2</version>
</dependency>

2、实体类

@Resource(name = "cat1")
private Cat cat;

@Resource()
private Dog dog;

3、配置文件

<context:annotation-config/>

<bean id="cat1" class="org.com.pojo.Cat"/>
<bean id="cat2" class="org.com.pojo.Cat"/>
<bean id="dog" class="org.com.pojo.Dog"/>
<bean id="user" class="org.com.pojo.User"/>

4、测试，输出正确！

5、修改配置文件，删除cat1

<context:annotation-config/>

<bean id="cat2" class="org.com.pojo.Cat"/>
<bean id="dog" class="org.com.pojo.Dog"/>
<bean id="user" class="org.com.pojo.User"/>

6、实体类

@Resource()
private Cat cat;

@Resource()
private Dog dog;

7、测试，输出成功！

结论：先进行byName查找，失败；再进行byType查找，成功。

小结：

@Autowired与@Resource异同：

1、@Autowired与@Resource都可以用来装配bean。都可以写在字段上，或写在setter方法上。

2、@Autowired默认按类型装配（属于spring规范），默认情况下必须要求依赖对象必须存在，如果要允许null 值，可以设置它的required属性为false，如：@Autowired(required=false) ，如果我们想使用名称装配可以结合@Qualifier注解进行使用

3、@Resource（属于J2EE复返），默认按照名称进行装配，名称可以通过name属性进行指定。如果没有指定name属性，当注解写在字段上时，默认取字段名进行按照名称查找，如果注解写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。

它们的作用相同都是用注解方式注入对象，但执行顺序不同。

@Autowired先byType，@Resource先byName。

5、作用域

@scope

singleton：默认的，Spring会采用单例模式创建这个对象。关闭工厂，所有的对象都会销毁。
prototype：多例模式。关闭工厂，所有的对象不会销毁。内部的垃圾回收机制会回收

@Component("user")
@Scope("singleton")
public class User {

    @Value("Tim")
    private String name;

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                '}';
    }
}

小结：

XML与注解比较

XML可以适用任何场景，结构清晰，维护方便
注解不是自己提供的类使用不了，开发简单方便

xml与注解整合开发 ：推荐最佳实践

xml管理Bean
注解完成属性注入
使用过程中，可以不用扫描，扫描是为了类上的注解

<context:annotation-config/>

作用：

进行注解驱动注册，从而使注解生效
用于激活那些已经在spring容器里注册过的bean上面的注解，也就是显示的向Spring注册
如果不扫描包，就需要手动配置bean
如果不加注解驱动，则注入的值为null！

6、基于Java类进行配置

JavaConfig 原来是 Spring 的一个子项目，它通过 Java 类的方式提供 Bean 的定义信息，在 Spring4 的版本， JavaConfig 已正式成为 Spring4 的核心功能。

测试步骤：

1、编写一个实体类

//将这个类标注为Spring的一个组件，放到容器中！
@Component
public class Pig {
    @Value("小欢") //注入属性值
    private String name;

    @Override
    public String toString() {
        return "Pig{" +
                "name='" + name + '\'' +
                '}';
    }
}

2、编写配置类

// 这个也会被Spring容器托管，注册到容器中去，因为他本来就是一个@Component
// @Configuration代表这是一个配置类，就和我们之前看的beans.xml
@Configuration
// 相当于<context:component-scan base-package="org.com.pojo"/> 
// 自动扫描，不用再注册bean了
@ComponentScan("org.com.pojo")
public class MyConfig {
	// 这里是演示一下怎么注册bean，这里有@ComponentScan，可以不注册
    // 注册一个bean，就相当于之前写的一个bean标签
    // 这个方法的名字，就相当于bean标签中的id属性
    // 这个方法的返回值，就相当于bean标签中的class属性
    @Bean
    public Pig pig(){
        return new Pig(); // 就是返回要注入到bean的对象
    }

}

3、测试

@Test
public void test2(){
    ApplicationContext context = new AnnotationConfigApplicationContext(MyConfig.class);
    Pig pig = context.getBean("pig", Pig.class);
    System.out.println(pig);
}

导入其他配置如何做呢？

1、我们再编写一个配置类！

@Configuration  //代表这是一个配置类
public class MyConfig2 {
}

2、在之前的配置类中我们来选择导入这个配置类

@Configuration
@ComponentScan("org.com.pojo")
// 导入其他配置类
@Import(MyConfig2.class)
public class MyConfig {

    @Bean
    public Pig pig(){
        return new Pig(); 
    }

}

关于这种Java类的配置方式，我们在之后的SpringBoot 和 SpringCloud中还会大量看到，我们需要知道这些注解的作用即可！

标签：装配,name,private,bean,开发,注解,public,Spring4
来源： https://www.cnblogs.com/javaconner/p/14752499.html