sprigboot热部署、引入nacos配置中心

ipu-rest-scaffold/pom.xml

@@ -79,6 +79,19 @@
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-actuator</artifactId>
		</dependency>
		<!--devtools热部署-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <optional>true</optional>
            <scope>true</scope>
        </dependency>
        <!-- 引入nacos服务注册及配置中心 -->
        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-config-spring-boot-starter</artifactId>
            <version>${nacos-config.version}</version>
        </dependency>
	</dependencies>

ipu-rest-scaffold/readme.md

@@ -22,6 +22,7 @@ webapp下可存放静态页面，便于前后端开发联调。
###三、SQL统一管理
SQL被统一存放在classpath的sql路径下，如：sql.ipu.demo。
使用命名空间+id的方式定位SQL配置，DbSqlMgmtController有代码使用范例。
###四、ipu-nosql组件
- 1.ipu-nosql组件的引入
    - 以maven为例,请在pom.xml中引入ipu-nosql组件和mongodb驱动包。如果使用的springboot为2.2.1.RELEASE或更高版本时，则不再需要添加mongodb驱动包。因为该版本已支持3.11.2的mongodb驱动包。
@@ -49,6 +50,7 @@ SQL被统一存放在classpath的sql路径下，如：sql.ipu.demo。
        <config name="needTranscation" value="true"/>
        ```
- 该组件使用案例在:MongoDbController中
###五、springboot优雅停止服务
- 1.组件的引入
    - 以maven为例,请在pom.xml中引入spring-boot-starter-actuator组件。
@@ -74,6 +76,44 @@ SQL被统一存放在classpath的sql路径下，如：sql.ipu.demo。
- 3.停止springboot应用的http接口只支持POST。在linux下使用命令curl -X POST http://127.0.0.1:12581/MyActuator/shutdown；在windows下使用工具，选择POST方式。
- 4.测试案例见GracefulTestController.java。在浏览器里输入http://服务ip:port/ipu/graceful/hello
###六、springboot热部署
- 1.组件的引入
    - 以maven为例,请在pom.xml中引入spring-boot-devtools组件。
        ```xml
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
        ```
- 2.在application.properties配置：
        ```properties
        #设置开启热部署
        spring.devtools.restart.enabled=true
        #重启目录
        spring.devtools.restart.additional-paths=src/main/java
        spring.devtools.restart.exclude=WEB-INF/**
        #页面热加载
        spring.freemarker.cache=false 
        ```
- 3.测试案例见NacosConfigController.java。
###七、nacos配置中心和注册中心
- 1.nacos配置中心组件的引入
    - 以maven为例,请在pom.xml中引入nacos组件。如果使用的springboot为2.x或更高版本时，需要使用0.2.1的nacos组件；使用的springboot为1.x，需要使用0.1.1的nacos组件。
        ```xml
        <dependency>
            <groupId>com.alibaba.boot</groupId>
            <artifactId>nacos-config-spring-boot-starter</artifactId>
            <version>0.1.1</version>
        </dependency>
        ```
- 2.nacos配置中心的配置文件为:application.properties
        ```properties
        nacos.config.server-addr=192.168.1.101:8848
        ```
- 3.nacos配置中心使用案例在NacosConfigController中。此案例只支持springboot，springcloud的示例不在当前工程。
###打包运行
java -Dipu.lic.path=ipu.lic -jar ipu-rest-scaffold.jar --server.port=8080

ipu-rest-scaffold/src/main/java/com/ai/ipu/server/RestScaffoldStart.java

@@ -18,7 +18,10 @@ public class RestScaffoldStart {
	    /*自定义Handler*/
	    defineHandler();
		/*注册异常信息编码配置*/
		IpuBaseException.registerCode(EXCEPTION_MESSAGES_CONFIG);
	    //热部署会多次加载，因此需要捕获并忽略异常
		try{
			IpuBaseException.registerCode(EXCEPTION_MESSAGES_CONFIG);
		}catch(Exception e) {}
		/*启动*/
	    IpuRestApplication.start(args);
	}

ipu-rest-scaffold/src/main/java/com/ai/ipu/server/config/NacosListenerConfiguration.java

@@ -0,0 +1,89 @@
package com.ai.ipu.server.config;
import static com.alibaba.nacos.api.common.Constants.DEFAULT_GROUP;
import javax.annotation.PostConstruct;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.listener.AbstractListener;
import com.alibaba.nacos.api.config.listener.Listener;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.spring.context.event.config.NacosConfigListenerRegisteredEvent;
import com.alibaba.nacos.spring.context.event.config.NacosConfigPublishedEvent;
import com.alibaba.nacos.spring.context.event.config.NacosConfigReceivedEvent;
import com.alibaba.nacos.spring.context.event.config.NacosConfigRemovedEvent;
@Configuration
public class NacosListenerConfiguration {
	private static final Logger logger = LoggerFactory.getLogger(NacosListenerConfiguration.class);
	@NacosInjected
    private ConfigService configService;
	
	@PostConstruct
    public void init() throws NacosException {
        Listener listener = new AbstractListener() {
//            @Override
            public void receiveConfigInfo(String configInfo) {
            }
        };
        //添加事件监听
        configService.addListener("com.ai.ipu.nacos", DEFAULT_GROUP, listener);
        
        //取消事件监听
        //configService.removeListener("com.ai.ipu.nacos", DEFAULT_GROUP, listener);
    }
    @Bean
    public ApplicationListener<NacosConfigReceivedEvent> nacosConfigReceivedEventListener() {
        return new ApplicationListener<NacosConfigReceivedEvent>() {
//            @Override
            public void onApplicationEvent(NacosConfigReceivedEvent event) {
                logger.info("Listening on NacosConfigReceivedEvent -  dataId : {} , groupId : {} , " + "content : {} , "
                        + "source : {}", event.getDataId(), event.getGroupId(), event.getContent(), event.getSource());
            }
        };
    }
    @Bean
    public ApplicationListener<NacosConfigRemovedEvent> nacosConfigRemovedEventListener() {
        return new ApplicationListener<NacosConfigRemovedEvent>() {
//            @Override
            public void onApplicationEvent(NacosConfigRemovedEvent event) {
                logger.info("Listening on NacosConfigRemovedEvent -  dataId : {} , groupId : {} , " + "removed : {} , "
                        + "source : {}", event.getDataId(), event.getGroupId(), event.isRemoved(), event.getSource());
            }
        };
    }
    @Bean
    public ApplicationListener<NacosConfigListenerRegisteredEvent> nacosConfigListenerRegisteredEventListener() {
        return new ApplicationListener<NacosConfigListenerRegisteredEvent>() {
//            @Override
            public void onApplicationEvent(NacosConfigListenerRegisteredEvent event) {
                logger.info("Listening on NacosConfigListenerRegisteredEvent -  dataId : {} , groupId : {} , " + "registered : {} , "
                        + "source : {}", event.getDataId(), event.getGroupId(), event.isRegistered(), event.getSource());
            }
        };
    }
    @Bean
    public ApplicationListener<NacosConfigPublishedEvent> nacosConfigPublishedEvent() {
        return new ApplicationListener<NacosConfigPublishedEvent>() {
//            @Override
            public void onApplicationEvent(NacosConfigPublishedEvent event) {
                logger.info("Listening on NacosConfigPublishedEvent -  dataId : {} , groupId : {} , " + "published : {} , "
                        + "source : {}", event.getDataId(), event.getGroupId(), event.isPublished(), event.getSource());
            }
        };
    }
}

ipu-rest-scaffold/src/main/java/com/ai/ipu/server/control/NacosConfigController.java

@@ -0,0 +1,65 @@
package com.ai.ipu.server.control;
import static com.alibaba.nacos.api.common.Constants.DEFAULT_GROUP;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import com.ai.ipu.data.JMap;
import com.alibaba.nacos.api.annotation.NacosInjected;
import com.alibaba.nacos.api.config.ConfigService;
import com.alibaba.nacos.api.config.annotation.NacosValue;
import com.alibaba.nacos.api.exception.NacosException;
import com.alibaba.nacos.spring.context.annotation.config.NacosPropertySource;
@Controller
@RequestMapping("/nacos/config")
@NacosPropertySource(dataId = "com.ai.ipu.nacos", autoRefreshed = true)
public class NacosConfigController {
	private static final Logger logger = LoggerFactory.getLogger(NacosConfigController.class);
	
	//用于发布消息到配置中心
	@NacosInjected
    private ConfigService configService;
	
	//如果配置中心没有dataId以及sql的配置，则取defaultValue
	//autoRefreshed：是否动态刷新。如果是动态刷新，则配置中心dataId以及sql的配置发生变动，则取配置中心的数据；
	//如果不是动态刷新，则在应用启动时去配置中心获取一次dataId以及sql的配置
	@NacosValue(value = "${sql:defaultValue}", autoRefreshed = true)
    private String sql;
	
	 @ResponseBody
	 @RequestMapping("/getSql")
	 public String getSql(JMap params) throws Exception {
		 return sql;
	 }
	 
	 @ResponseBody
	 @RequestMapping("/setSql")
	 public boolean setSql(JMap params) throws Exception {
		 try {
			    //将select * from display.tab_page_info发布到配置中心，dataId=com.ai.ipu.nacos，变量名=sql
	            configService.publishConfig("com.ai.ipu.nacos", DEFAULT_GROUP, "sql = select * from display.tab_page_info");
	            return true;
	        } catch (NacosException e) {
	            e.printStackTrace();
	            return false;
	        }
	 }
	 /* 用于测试热加载 */
	 @ResponseBody
	 @RequestMapping("/removeSql")
	 public boolean removeSql(JMap params) throws Exception {
		 try {
			    //从配置中心删除配置，dataId=com.ai.ipu.nacos
	            configService.removeConfig("com.ai.ipu.nacos", DEFAULT_GROUP);
	            return true;
	        } catch (NacosException e) {
	            e.printStackTrace();
	            return false;
	        }
	 }
}

ipu-rest-scaffold/src/main/resources/dev/application.properties

@@ -32,3 +32,14 @@ management.context-path=/MyActuator
management.port=12581
# 不允许远程管理连接(不允许外部调用保证安全)
management.address=127.0.0.1
#设置开启热部署
spring.devtools.restart.enabled=true
#重启目录
spring.devtools.restart.additional-paths=src/main/java
spring.devtools.restart.exclude=WEB-INF/**
#页面热加载
spring.freemarker.cache=false 
###配置nacos
nacos.config.server-addr=10.1.234.70:8848