一个例子实现系统启动后初始化一些数据

港控/mmm° 2023-07-14 08:24 12阅读 0赞

springboot在系统启动后要执行一些数据可以写一个类实现ApplicationRunner接口。

在一个bean构建后进行初始化可以用注解@PostConstruct

写个简单的小例子练练手。

为了在系统启动后规范执行的行为，我定义了一个接口：

package com.example.gate.init.business;
    
    public interface InitDataService {
    
    	public boolean initData();
    }

写N个实现类，继承这个接口。这样就有N个service，我们逐个调initData方法来实现不同数据的初始化。

为了让调用实现可配置，我们把实现类的bean名称定义到yml配置文件中。

先写2个实现类，这是业务代码了

package com.example.gate.init.business.impl;
    
    import org.springframework.stereotype.Service;
    
    import com.example.gate.init.business.InitDataService;
    
    @Service
    public class InitSysDataService implements InitDataService{
    
    	@Override
    	public boolean initData() {
    		System.out.println("初始化系统数据完毕。。");
    		return true;
    	}
    
    }

package com.example.gate.init.business.impl;
    
    import org.springframework.stereotype.Service;
    
    import com.example.gate.init.business.InitDataService;
    @Service
    public class InitRedisDataService implements InitDataService{
    
    	@Override
    	public boolean initData() {
    		System.out.println("初始化redis数据完毕。。");
    		return true;
    	}
    
    }

application.yml 配置：

#系统启动后调用的service进行初始化数据，按顺序执行InitDataService 
    initservicelist:
      servicesMap: 
        1: initSysDataService 
        2: initRedisDataService
    #    12: paramService2 
    #    37: userServicegg 
    #    3: userService3

读取yml配置的类：

package com.example.gate.bean;
    
    import java.util.Comparator;
    import java.util.Iterator;
    import java.util.LinkedHashMap;
    import java.util.Map;
    import java.util.TreeMap;
    import java.util.concurrent.ConcurrentHashMap;
    
    import javax.annotation.PostConstruct;
    
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    
    /**
     * 一个yml映射map的例子，我做了排序。
     * 
     * 应用场景：系统启动后要初始化一些业务数据，每个初始化的功能都写在一个规定好的service接口中。
     * 拿到这个map中的bean名称，去spring容器中找到这个bean，调用他的方法。
     * 排序是为了应对某些数据的初始化有前后依赖关系。
     * 
     * @author lsy
     *
     */
    @Component
    @ConfigurationProperties(prefix = "initservicelist")
    public class InitServiceConfig {
    
    //	private Map<String , String> servicesMap = new ConcurrentHashMap<String , String>(){};
    	
    	private Map<String, String> servicesMap = new TreeMap<String , String>(new Comparator() {
    		@Override
    		public int compare(Object o1, Object o2) {
    			String key1=(o1==null)?"":(String)o1;
    			String key2=(o2==null)?"":(String)o2;
    			int num1 = Integer.MAX_VALUE;
    			int num2 = Integer.MAX_VALUE;
    			try {
    				num1=Integer.valueOf(key1);
    			} catch (NumberFormatException e) {
    				num1 = Integer.MAX_VALUE;
    			}
    			try {
    				num2=Integer.valueOf(key2);
    			} catch (NumberFormatException e) {
    				num1 = Integer.MAX_VALUE;
    			}
    			
    			return num1 - num2;
    		}
    	}){};
    
    	public Map<String, String> getServicesMap() {
    		return servicesMap;
    	}
    
    	public void setServicesMap(Map<String, String> servicesMap) {
    		this.servicesMap = servicesMap;
    	}
    
    	@Override
    	public String toString() {
    		return "InitServiceConfig [servicesMap=" + servicesMap + "]";
    	}
    
    	@PostConstruct
        public void init() {
    		System.out.println("InitServiceConfig servicesMap内容:"+servicesMap.toString());
    		if(servicesMap!=null) {
    			Iterator it = servicesMap.keySet().iterator();
    //			int inx = 1;
    			while(it.hasNext()) {
    				String key = (String)it.next();
    				String value = (String)this.servicesMap.get(key);//
    				System.out.println("加载缓存顺序"+key+"==="+value);
    			}
    		}else {
    			System.out.println("加载缓存servicesMap配置为空。。。。");
    		}
    		
    	}
    }

注意2个地方：

1，为了让我们的service有序，我使用的map做了排序。 Comparator

这样就按照yml中定义的数字进行排序了。

2，@PostConstruct  
    public void init()

这个方法仅仅是为了演示@PostConstruct的作用，我们可以看出这个定义类的map中是否实现了排序。

最后要在ApplicationRunner循环调用我们的service

@Component
    public class InitRouteRunner implements ApplicationRunner {
            private static final Logger logger = LoggerFactory.getLogger(InitRouteRunner.class);
    
            @Override
            public void run(ApplicationArguments args) throws Exception {
            	initDataAfterStart();//初始化系统数据
            }
    
            
            @Autowired
            InitServiceConfig initServiceConfig;
            
            @Autowired
            ApplicationContext applicationContext;//spring容器
            
            
            /**
             * 按顺序执行InitDataService的initData方法，在系统启动后初始化一些数据
             */
            public void initDataAfterStart() {
            	if(applicationContext==null) {
            		System.out.println("error applicationContext is null.");
            		return;
            	}
            	System.out.println("initDataAfterStart开始执行预定义的初始化服务。。。");
            	if(initServiceConfig.getServicesMap()!=null) {
        			Iterator it = initServiceConfig.getServicesMap().keySet().iterator();
        			while(it.hasNext()) {
        				String key = (String)it.next();
        				String value = (String)this.initServiceConfig.getServicesMap().get(key);//
        				if(value!=null && !value.trim().equals("")) {
        					try {
    							if(applicationContext.getBean(value.trim())!=null) {
    								InitDataService initDataService = (InitDataService)applicationContext.getBean(value.trim());
    								boolean res = initDataService.initData();
    								if(res) {
    									System.out.println(value.trim()+"初始化数据成功~~~");
    								}else {
    									System.out.println(value.trim()+"初始化数据失败！！！");
    								}
    							}
    						} catch (Exception e) {
    							e.printStackTrace();
    							System.out.println(value.trim()+"初始化数据失败！！！");
    							continue;
    						}
        				}
        				System.out.println("加载缓存顺序"+key+"==="+value);
        			}//end while
        		}else {
        			System.out.println("加载缓存servicesMap配置为空。。。。");
        		}
            }
        	
    }

这样在系统启动后，就调用service的实现了，这样的初始化数据实现了可配置。

打印：

2020-03-14 00:53:27.508  INFO 16956 --- \[           main\] o.s.w.r.r.m.a.ControllerMethodResolver   : Looking for @ControllerAdvice: org.springframework.boot.web.reactive.context.AnnotationConfigReactiveWebServerApplicationContext@66238be2: startup date \[Sat Mar 14 00:53:20 CST 2020\]; parent: org.springframework.context.annotation.AnnotationConfigApplicationContext@39ac0c0a  
InitServiceConfig servicesMap内容:\{1=initSysDataService, 2=initRedisDataService\}  
加载缓存顺序1===initSysDataService  
加载缓存顺序2===initRedisDataService  
2020-03-14 00:53:27.875  INFO 16956 --- \[           main\] c.e.g.l.self.ChannelRedisRateLimiter     : setApplicationContext自定义限流配置：RateLimiterConf==true  
2020-03-14 00:53:27.892  INFO 16956 --- \[           main\] c.e.gate.limit.self.IPRedisRateLimiter   : setApplicationContext自定义限流配置：RateLimiterConf==true  
2020-03-14 00:53:27.922  WARN 16956 --- \[           main\] c.n.c.sources.URLConfigurationSource     : No URLs will be polled as dynamic configuration sources.  
2020-03-14 00:53:27.922  INFO 16956 --- \[           main\] c.n.c.sources.URLConfigurationSource     : To enable URLs as dynamic configuration sources, define System property archaius.configurationSource.additionalUrls or make config.properties available on classpath.  
2020-03-14 00:53:28.668  INFO 16956 --- \[           main\] o.s.s.c.ThreadPoolTaskScheduler          : Initializing ExecutorService  'catalogWatchTaskScheduler'  
2020-03-14 00:53:28.849  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Registering beans for JMX exposure on startup  
2020-03-14 00:53:28.862  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Bean with name 'environmentManager' has been autodetected for JMX exposure  
2020-03-14 00:53:28.863  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Bean with name 'refreshScope' has been autodetected for JMX exposure  
2020-03-14 00:53:28.864  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Bean with name 'configurationPropertiesRebinder' has been autodetected for JMX exposure  
2020-03-14 00:53:28.867  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Located managed bean 'environmentManager': registering with JMX server as MBean \[org.springframework.cloud.context.environment:name=environmentManager,type=EnvironmentManager\]  
2020-03-14 00:53:28.877  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Located managed bean 'refreshScope': registering with JMX server as MBean \[org.springframework.cloud.context.scope.refresh:name=refreshScope,type=RefreshScope\]  
2020-03-14 00:53:28.892  INFO 16956 --- \[           main\] o.s.j.e.a.AnnotationMBeanExporter        : Located managed bean 'configurationPropertiesRebinder': registering with JMX server as MBean \[org.springframework.cloud.context.properties:name=configurationPropertiesRebinder,context=66238be2,type=ConfigurationPropertiesRebinder\]  
2020-03-14 00:53:28.905  INFO 16956 --- \[           main\] o.s.c.support.DefaultLifecycleProcessor  : Starting beans in phase 0  
2020-03-14 00:53:29.610  INFO 16956 --- \[ctor-http-nio-1\] r.ipc.netty.tcp.BlockingNettyContext     : Started HttpServer on /0:0:0:0:0:0:0:0:8888  
2020-03-14 00:53:29.611  INFO 16956 --- \[           main\] o.s.b.web.embedded.netty.NettyWebServer  : Netty started on port(s): 8888  
2020-03-14 00:53:29.630  INFO 16956 --- \[           main\] o.s.c.c.s.ConsulServiceRegistry          : Registering service with consul: NewService\{id='gate-192-168-124-17-8888', name='gate', tags=\[secure=false\], address='192.168.124.17', port=8888, enableTagOverride=null, check=Check\{script='null', interval='10s', ttl='null', http='http://192.168.124.17:8888/actuator/health', tcp='null', timeout='10s', deregisterCriticalServiceAfter='null', tlsSkipVerify=null, status='null'\}, checks=null\}  
2020-03-14 00:53:29.647  INFO 16956 --- \[           main\] com.example.gate.GateApplication         : Started GateApplication in 11.932 seconds (JVM running for 12.838)  
initDataAfterStart开始执行预定义的初始化服务。。。  
初始化系统数据完毕。。  
initSysDataService初始化数据成功~~~  
加载缓存顺序1===initSysDataService  
初始化redis数据完毕。。  
initRedisDataService初始化数据成功~~~  
加载缓存顺序2===initRedisDataService  
2020-03-14 00:53:30.290  INFO 16956 --- \[ctor-http-nio-2\] io.lettuce.core.EpollProvider            : Starting without optional epoll library  
2020-03-14 00:53:30.293  INFO 16956 --- \[ctor-http-nio-2\] io.lettuce.core.KqueueProvider           : Starting without optional kqueue library