Springboot项目实现在主启动类启动后自动执行我们自定义的代码逻辑

曾经终败给现在 2022-12-23 07:08 267阅读 0赞

#### 一、问题背景 ####

开发一个Springboot项目，想在项目启动后，不采用接口调用的方式，就能立即执行我自定义的代码逻辑。

#### 二、解决办法 ####

针对上述情况，Springboot提供了 **CommandLineRunner和ApplicationRunner** 两种方式实现**这种“开机自启”功能**。CommandLineRunner、ApplicationRunner接口是在容器启动成功后的最后一步回调，这两种方法提供的 **目的** 是为了满足在 **项目启动的时候立刻执行某些方法**

##### 2.1 CommandLineRunner接口 #####

###### 2.1.1 建立一个事件监听类 ######

JdbcAutoStartup类

@Component
    public class JdbcAutoStartup implements CommandLineRunner {
        @Override
        public void run(String... args) throws Exception {
            try{
                JDBCConnection.mysqlDriver();
            }catch (Exception e){
                e.printStackTrace();
            }
        }
    }

JDBCConnection类

public class JDBCConnection {
        public static String url_encrypt="jdbc:mysql://172.16.xx.xx:3306/rap_db?useSSL=false";
        public static String user="rap_db";
        public static String password="rap_db_123";
    
        public static void mysqlDriver() throws Exception
        {
            Class.forName("com.mysql.jdbc.Driver");
            Connection conn  = DriverManager.getConnection(url_encrypt,user,password);
            Statement stmt= conn.createStatement();
    
            while (true) {
                try {
                    long before = System.currentTimeMillis();
                    ResultSet rs = stmt.executeQuery("select project_data from tb_project where name='umeapi-plus'");
                    long after = System.currentTimeMillis();
                    System.out.println("执行时间：" + (after - before));
                } catch (Exception e) {
                    System.out.println(e.getMessage());
                }
                TimeUnit.SECONDS.sleep(3);
            }
        }
    }

###### 2.1.2 建立多个事件监听类 ######

只需要定义多个 **2.1.1** 中的监听类，然后通过 **@Order注解** 或者 **实现Order接口** 来标明 **加载顺序**

@Component
    @Order(1)
    public class MyStartRunner implements CommandLineRunner {
        @Override
        public void run(String... args) throws Exception {
            System.out.println("自己定义的第一个启动后事件开始执行。。。。。。。");
        }
    }

@Component
    @Order(2)
    public class MyStartRunner2 implements CommandLineRunner {
        @Override
        public void run(String... args) throws Exception {
            System.out.println("自己定义的第二个启动后事件开始执行。。。。。。。");
        }
    }

##### 2.2 ApplicationRunner接口 #####

###### 2.2.1 建立一个事件监听类 ######

@Component
    public class MyApplicationRunner implements ApplicationRunner {
        @Override
        public void run(ApplicationArguments args) throws Exception {
            System.out.println("我自定义的ApplicationRunner事件。。。。。。");
        }
    }

###### 2.2.1 建立多个事件监听类 ######

只需要定义多个 **2.2.1** 中的监听类，然后通过 **@Order注解** 或者 **实现Order接口** 来标明 **加载顺序**

@Slf4j
    @Component
    public class DefaultApplicationRunner implements ApplicationRunner, Ordered {
        @Override
        public void run(ApplicationArguments args) throws Exception {
            log.info("i am applicationRunner");
            Set<String> optionNames = args.getOptionNames();
            log.info("optionNames = " + optionNames);
            String[] sourceArgs = args.getSourceArgs();
            log.info("sourceArgs = " + Arrays.toString(sourceArgs));
            List<String> nonOptionArgs = args.getNonOptionArgs();
            log.info("nonOptionArgs = " + nonOptionArgs);
            List<String> optionValues = args.getOptionValues("foo");
            log.info("optionValues = " + optionValues);
        }
     
        @Override
        public int getOrder() {
            return Integer.MIN_VALUE+2;
        }
    }

##### 2.3 CommandLineRunner与ApplicationRunner的区别 #####

CommandLineRunner 接收**可变参数String… args**，而ApplicationRunner 接收一个封装好的**对象参数ApplicationArguments**。除此之外，它们功能完全一样，甚至连方法名都一样

Springboot应用启动时是可以接受参数的，也就是Springboot的**main方法是可以接受参数的**。这些参数通过**命令行** java -jar yourapp.jar 来传递。CommandLineRunner会**原封不动照单全收**这些接口；这些参数也可以**封装到ApplicationArguments对象**中供ApplicationRunner调用