Spring 5 @PostConstruct 和 @PreDestroy 示例

x33g5p2x  于2022-10-06 转载在 Spring  
字(4.9k)|赞(0)|评价(0)|浏览(582)

在这篇文章中,我们将讨论如何使用方法级注解@PostConstruct@PreDestroy来定制Bean的性质。

注意,@PostConstruct和@PreDestroy注解不属于Spring,它位于J2ee库中 - common-annotations.jar.** JSR-250 @PostConstruct和@PreDestroy注解通常被认为是现代Spring应用程序中接收生命周期回调的最佳实践。使用这些注解意味着你的Bean不会被耦合到Spring特定的接口上**。

Spring内部使用CommonAnnotationBeanPostProcessor类来处理JSR-250 @PostConstruct@PreDestroy注释。
@PostConstruct注解用于依赖注入完成后需要执行的方法,以执行任何初始化。

@PreDestroy注解被用在方法上,作为回调通知,以示实例正在被容器移除。
在本文中,为了快速演示,我们使用Spring 5.1.0.RELEASE的最新版本。

Spring @PostConstruct 和 @PreDestroy 示例

在实时项目中,我们会在应用程序启动时用一些记录填充一个数据库表,并在应用程序关闭时从同一数据库表中删除记录。

在这个例子中,我们将使用init()方法和@PostConstruct注解,在应用程序启动时向内存中的List数据结构填充一些用户对象。在应用程序关闭期间,我们还将使用注有@PreDestroy注释的destroy()方法从List删除用户对象。

使用的工具和技术

  • Spring Framework - 5.1.0.RELEASE
  • JDK - 8或更高版本
  • Maven - 3.2以上
  • IDE - Eclipse Mars/STS

创建一个简单的Maven项目

使用你喜欢的IDE创建一个简单的Maven项目,关于打包结构请参考下面的章节。如果你是maven新手,请阅读本文《如何创建一个简单的Maven项目》。

项目结构

下图显示了项目结构,供您参考。

the pom.xml File

<project xmlns="http://maven.apache.org/POM/4.0.0"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>net.javaguides.spring</groupId>
    <artifactId>spring-bean-lifecycle</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.1.0.RELEASE</version>
        </dependency>  
    </dependencies>
    <build>
     <sourceDirectory>src/main/java</sourceDirectory>
         <plugins>
            <plugin>
               <artifactId>maven-compiler-plugin</artifactId>
               <version>3.5.1</version>
               <configuration>
                   <source>1.8</source>
                   <target>1.8</target>
               </configuration>
           </plugin>
         </plugins>
     </build>
</project>

考虑DatabaseInitiaizer Bean,其init()destroy()方法分别被注解为@PostConstruct@PreDestroy

DatabaseInitiaizer.java

package net.javaguides.spring;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;

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

import org.springframework.stereotype.Component;

@Component
public class DatabaseInitiaizer {

    private List < User > listOfUsers = new ArrayList < > ();

    @PostConstruct
    public void init() {
        User user = new User(1, "User");
        User user1 = new User(2, "Admin");
        User user2 = new User(3, "SuperAdmin");

        listOfUsers.add(user);
        listOfUsers.add(user1);
        listOfUsers.add(user2);
        System.out.println("-----------List of users added in init() method ------------");
        for (Iterator < User > iterator = listOfUsers.iterator(); iterator.hasNext();) {
            User user3 = (User) iterator.next();
            System.out.println(user3.toString());
        }
        // save to database

    }

    @PreDestroy
    public void destroy() {
        // Delete from database
        listOfUsers.clear();
        System.out.println("-----------After of users removed from List in destroy() method ------------");
        for (Iterator < User > iterator = listOfUsers.iterator(); iterator.hasNext();) {
            User user3 = (User) iterator.next();
            System.out.println(user3.toString());
        }
    }
}

Create POJO - User.java

package net.javaguides.spring;

public class User {
    private Integer id;
    private String name;

    public User() {}

    public User(Integer id, String name) {
        super();
        this.id = id;
        this.name = name;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

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

    @Override
    public String toString() {
        return "User [id=" + id + ", name=" + name + "]";
    }
}

基于注解的配置 - AppConfig.java

创建AppConfig类,并在其中编写以下代码。

package net.javaguides.spring;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan(basePackages = "net.javaguides.spring")
public class AppConfig {
 
}

注意 - @ComponentScan注解会扫描所有的Bean,这些Bean的类被@Component注解所注解,在一个由basePackages属性指定的包中。

运行中的Spring应用程序 - Application.java

让我们创建一个主类并运行一个应用程序。

package net.javaguides.spring;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Application {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        context.close();
    }
}

输出

-----------List of users added in init() method ------------
User [id=1, name=User]
User [id=2, name=Admin]
User [id=3, name=SuperAdmin]
-----------After of users removed from List in destroy() method -------

请注意,destroy()方法清除了用户对象的列表,控制台中没有显示任何东西。
正如你所看到的,init()destroy() bean的方法只被调用一次,当bean的作用域是单子(默认作用域)时。

在原型作用域的情况下,DatabaseInitiaizer Bean的destroy方法将不起作用。这篇文章的源代码可在我的GitHub仓库https://github.com/RameshMF/spring-core-tutorial上找到。

相关文章