Spring之注解开发

2022-11-18 13:52:23 浏览数 (1)

8、使用注解开发

8.1.什么是注解?

  • 注解是代码特殊标记,格式:@注解名称(属性名称=属性值,属性名称=属性值)
  • 使用注解,注解作用在类上面,方法上面,属性上面
  • 使用注解目的:简化xml文件的配置。

注解的弊端:

  • 为了达成注解驱动的目的,可能会将原先很简单的书写,变的更加复杂
  • XML中配置第三方开发的资源是很方便的,但使用注解驱动无法在第三方开发的资源中进行编辑,因此会增大开发工作量

8.2.Spring针对Bean管理中创建对象提供注解

  • @Component:用于类中,普通的注解,都可以创建对象,泛指组件,当组件不好归类的时候,我们可以使用这个注解进行标注。
  • @Service:用于业务层中,用于标注业务层组件
  • @Controller:用于web层,用于标注控制层组件(如struts中的action)
  • @Repository:用于dao层,用于标注数据访问组件,即DAO组件.

  • @Controller : 一般用于表现层的注解。
  • @Service : 一般用于业务层的注解。
  • @Repository : 一般用于持久层的注解。

细节:如果注解中有且只有一个属性要赋值时,且名称是 value , value 在赋值是可以不写。

四种都可用在各个层使用。均可以创建bean实例,对象。

8.3.基本注解方式创建对象

①带入依赖

在Spring4之后,要使用注解开发,必须要保证 aop的包导入了

②开启注解

引入名称空间

代码语言:javascript复制
<context:annotation-config/>		//启动注解

<context:component-scan base-package="包的路径"/>   //包扫描
  • 说明:
    • 在进行包所扫描时,会对配置的包及其子包中所有文件进行扫描
    • 扫描过程是以文件夹递归迭代的形式进行的
    • 扫描过程仅读取合法的Java文件
    • 扫描时仅读取Spring可识别的注解
    • 扫描结束后会将可识别的有效注解转化为spring对应的资源加入IoC容器
  • 注意:
    • 无论是注解格式还是XML配置格式,最终都是将资源加载到IoC容器中,差别仅仅是数据读取方式不同
    • 从加载效率上来说注解优于XML配置文件

使用注解需要导入context约束,增加注解的支持!

代码语言:javascript复制
<?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"
       xmlns:aop="http://www.springframework.org/schema/aop"
       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
       http://www.springframework.org/schema/aop
       http://www.springframework.org/schema/conaoptext/spring-aop.xsd">

    <!-- 开启注解的支持-->
    <context:annotation-config/>
   
</beans>

模块

代码语言:javascript复制
<!--扫描机制,这个包就会烧苗这个下的所有文件下的注解,使其生效-->
<!--开启组件扫描,扫描多个包用,隔开-->
<context:component-scan base-package="com.AnnotationDevelopment"/>
  • @Component:用于类中,普通的注解,都可以创建对象
  • @Service:用于业务层中
  • @Controller:用于web层
  • @Repository:用于dao层

在类上添加以上其中一个注解就可以创建一个对象

代码语言:javascript复制
//等价于  <bean id="user" class="com.AnnotationDevelopment.pojo.User"/>
//组件   Component
@Component

8.4.开启组件扫描细节配置

代码语言:javascript复制
<context:component-scan base-package="com.AnnotationDevelopment"/>
代码语言:javascript复制
    <!--示例一:
    use-default-filters="false":不使用默认的扫描机制,扫描指定位置的内容
    context:include-filter:设置指定的扫描内容
    -->
    <!--use-default-filters="false"  ——》不是扫面整个包,只扫描Controller注解的类,-->
    <context:component-scan base-package="com.AnnotationDevelopment" use-default-filters="false">
        <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>
    
    <!--示例二:
     use-default-filters="false":指定位置的内容不扫描指定的内容
     context:exclude-filter:指定位置的内容
    -->
    <context:component-scan base-package="com.AnnotationDevelopment">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>

8.5.属性注解方式实现属性注入

  • @Autowired:根据属性类型进行自动装配
  • @Qualifier:根据属性名称进行注入,id
  • @Resource:可以根据类型注入,也可以根据名称注入,相当于@Autowired @Qualifier
  • @Value:注入普通类型属性

属性注入:

  • 使用@Autowired进行自动注入
    • @Autowired默认按照类型进行注入
    • 如果存在两个相同Bean类型相同,则按照名称注入
  • @Autowired注入时可以针对成员变量或者set方法
  • 通过@Autowired的required属性,设置一定要找到匹配的Bean
  • 使用@Qualifier指定注入Bean的名称
  • 使用Qualifier指定Bean名称后,注解Bean必须指定相同名称
  • Spring提供对JSR-250中定义@Resource标准注解的支持

普通数据类型的属性注入

  • @Value(“值”)

引用数据类型的属性注入

  • @Autowired
  • @Qualifier(“”)
  • @Resource(name=“userDao”)

① @Autowired:根据属性类型进行自动装配:

作用:自动按照类型注入。当使用注解注入属性时, set 方法可以省略。它只能注入其他 bean 类型。当有多个类型匹配时,使用要注入的对象变量名称作为 bean 的 id ,在 spring 容器查找,找到了也可以注入成功。找不到就报错。

  • 在bean中的属性上通过@Autowired实现自定义bean类型的属性注入
  • 使用是对应的bean必须被spring管理,即手动配置了bean或者在类上添加了@Component注解
代码语言:javascript复制
@Service
public class UserService {
    //定义属性
    //不需要添加set方法
    //添加注入属性注解
    @Autowired
    private UserDao userDao;

    public void add(){
        System.out.println("UserService......................");
    }
}

② @Qualifier:根据属性名称进行注入

代码语言:javascript复制
@Service
public class UserService {
    //定义属性
    //不需要添加set方法
    //添加注入属性注解
    @Qualifier("userDaoImpl1")//根据名称注入
    private UserDao userDao;

    public void add(){
        System.out.println("UserService......................");
    }
}

③ @Resource:可以根据类型注入,也可以根据名称注入

@Resource是Java自带的注解

代码语言:javascript复制
@Service
public class UserService {
    //定义属性
    //不需要添加set方法
    //添加注入属性注解
    @Resource(name = "userDao1")  //根据名称进行注入
    private UserDao userDao;

    //@Autowired
    public void setUserDao(UserDao userDao) {
        this.userDao = userDao;
    }

    public void add(){
        System.out.println("UserService......................");
        userDao.save();
    }
}

④ @Value:注入普通类型属性

作用:注入基本数据类型和 String 类型数据的

属性:value :用于指定值

代码语言:javascript复制
@Component
public class User {
    // @Value 等价于   <property name="user" value="楠木"/>
    @Value("楠木")
    public String username;
}

8.6.属性如何注入

user

代码语言:javascript复制
@Component
public class User {
    public String name = "blue";
}

@Component

  • 组件,放在类上,说明这个类被spring管理了,就是bean!

test

代码语言:javascript复制
public class MyTest {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        User user = context.getBean("user", User.class);
        System.out.println(user.name);
	}
}

去掉名字内容,测试结果为null

@Value

8.7.衍生的注解

@Component 有几个衍生注解,我们在web开发中,会按mvc三层架构分层

  • dao 【@Repository】
  • service 【@Service】
  • controller 【@Controller】

这四个注解功能都是一样的,都是代表将某个类注册到spring中,装配Bean.

8.8.自动装配置

@Autowired:自动装配通过类型。名字 如果Autowired不能唯一自动装配上属性,则需要通过@Qualifier(va1ue=“xxx”) @Nullable :字段标记了这个注解,说明这个字段可以为null; @Resource :自动装配通过名字。类型。

当一个类Class A中需要一个B类型的变量时,在声明变量时加上这个注解 spring会在容器中寻找有没有

8.9.作用域

代码语言:javascript复制
@Component
@Scope("prototype")
public class User {
    public String name;

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

8.10.完全注解开发–无xml文件

① 创建配置类,代替xml配置文件

代码语言:javascript复制
@Configuration    //作为配置类 ,代替xml配置文件
@ComponentScan(basePackages = {"com.AnnotationDevelopment"})  //注解扫描
public class SpringConfig {
}

②测试类

代码语言:javascript复制
public class App {
    //这是一个main方法,是程序的入口:
    public static void main(String[] args) {
        //加载配置类
        ApplicationContext context = new AnnotationConfigApplicationContext(SpringConfig.class);
        User user = context.getBean("user", User.class);
        System.out.println(user.username);

        UserService userService = context.getBean("userService", UserService.class);
        userService.add();
    }
}

8.11.常用注解总结

Spring原始注解

Spring原始注解主要是替代的配置

注:红色需要掌握。

常用注解

8.11.1.启动注解功能

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

代码语言:javascript复制
<context:component-scan base-package="packageName"/>

说明:

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

注意:

  • 无论是注解格式还是XML配置格式,最终都是将资源加载到IoC容器中,差别仅仅是数据读取方式不同
  • 从加载效率上来说注解优于XML配置文件

8.11.2.bean的定义

名称:@Component @Controller @Service @Repository

类型:类注解

位置:类定义上方

作用:设置该类为spring管理的bean

范例:

代码语言:javascript复制
@Component
public class ClassName{}

说明:

  • @Controller、@Service 、@Repository是@Component的衍生注解,功能同@Component

相关属性

  • value(默认):定义bean的访问id

8.11.3.bean的作用域

名称:@Scope

类型:类注解

位置:类定义上方

作用:设置该类作为bean对应的scope属性

范例:

代码语言:javascript复制
@Scope
public class ClassName{}

相关属性

  • value(默认):定义bean的作用域,默认为singleton

8.11.4.bean的生命周期

名称:@PostConstruct、@PreDestroy

类型:方法注解

位置:方法定义上方

作用:设置该类作为bean对应的生命周期方法

范例:

代码语言:javascript复制
@PostConstruct
public void init() { System.out.println("init..."); }

8.11.5.加载第三方资源

名称:@Bean

类型:方法注解

位置:方法定义上方

作用:设置该方法的返回值作为spring管理的bean

范例:

代码语言:javascript复制
@Bean("dataSource")
public DruidDataSource createDataSource() {    return ……;    }

说明:

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

相关属性

  • value(默认):定义bean的访问id

8.11.6.bean的非引用类型属性注入

名称:@Value

类型:属性注解、方法注解

位置:属性定义上方,方法定义上方

作用:设置对应属性的值或对方法进行传参

范例:

代码语言:javascript复制
@Value("${jdbc.username}")
private String username;

说明:

  • value值仅支持非引用类型数据,赋值时对方法的所有参数全部赋值
  • value值支持读取properties文件中的属性值,通过类属性将properties中数据传入类中
  • value值支持SpEL
  • @value注解如果添加在属性上方,可以省略set方法(set方法的目的是为属性赋值)

相关属性

  • value(默认):定义对应的属性值或参数值

8.11.7.bean的引用类型属性注入

名称:@Autowired、@Qualifier

类型:属性注解、方法注解

位置:属性定义上方,方法定义上方

作用:设置对应属性的对象或对方法进行引用类型传参

范例:

代码语言:javascript复制
@Autowired(required = false)
@Qualifier("userDao")
private UserDao userDao;

说明:

  • @Autowired默认按类型装配,指定@Qualifier后可以指定自动装配的bean的id

相关属性

  • required:定义该属性是否允许为null

8.11.8.bean的引用类型属性注入

名称:@Primary

类型:类注解

位置:类定义上方

作用:设置类对应的bean按类型装配时优先装配

范例:

代码语言:javascript复制
@Primary
public class ClassName{}

说明:

  • @Autowired默认按类型装配,当出现相同类型的bean,使用@Primary提高按类型自动装配的优先级,多个@Primary会导致优先级设置无效

8.11.9.bean的引用类型属性注入

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

8.11.10.加载properties文件

名称:@PropertySource

类型:类注解

位置:类定义上方

作用:加载properties文件中的属性值

范例:

代码语言:javascript复制
@PropertySource(value = "classpath:filename.properties")
public class ClassName {
    @Value("${propertiesAttributeName}")
    private String attributeName;
}

说明:

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

相关属性

  • value(默认):设置加载的properties文件名
  • ignoreResourceNotFound:如果资源未找到,是否忽略,默认为false

8.11.11.纯注解格式

名称:@Configuration、@ComponentScan

类型:类注解

位置:类定义上方

作用:设置当前类为spring核心配置加载类

范例:

代码语言:javascript复制
@Configuration   //spring知道这个是一个配置泪
@ComponentScan("scanPackageName")   //扫描文件,加载路径,组件扫描
public class SpringConfigClassName{
}

说明:

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

AnnotationConfigApplicationContext

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

代码语言:javascript复制
AnnotationConfigApplicationContext ctx = new AnnotationConfigApplicationContext(SpringConfig.class);

8.11.12.第三方bean配置与管理

名称:@Import

类型:类注解

位置:类定义上方

作用:导入第三方bean作为spring控制的资源

范例:

代码语言:javascript复制
@Configuration
@Import(OtherClassName.class)
public class ClassName {
}

说明:

  • @Import注解在同一个类上,仅允许添加一次,如果需要导入多个,使用数组的形式进行设定
  • 在被导入的类中可以继续使用@Import导入其他资源(了解)
  • @Bean所在的类可以使用导入的形式进入spring容器,无需声明为bean

8.12.小结

xml与注解:

  • xml更加万能,适用于任何场合!维护简单方便
  • 注解 不是自己类使用不了,维护相对复杂!

xml与 注解最佳实践:

  • xml 用来管理bean;
  • 注解只负责完成属性的注入;
  • 我们在使用的过程中,只需要注意一个问题:必须让注解生效,就需要开启注解的支持
代码语言:javascript复制
<!-- 指定要扫描的包,这个包下的注解就会生效-->
    <context:component-scan base-package="com.blue"/>
    <context:annotation-config/>

 <!--扫描机制,这个包就会烧苗这个下的所有文件下的注解,使其生效-->
    <!--开启组件扫描,扫描多个包用,隔开-->
    <context:component-scan base-package="com.AnnotationDevelopment"/>

    <!--开启注解注入-->
    <context:annotation-config/>

0 人点赞