使用WinSW将SpringBoot应用注册为Windows服务

使用WinSW将SpringBoot应用注册为Windows服务

WinSW是一个开源项目，作用是将各种应用注册为Windows服务，项目下载地址：https://github.com/winsw/winsw/releases

1、配置xml

先将springboot项目打成jar包，然后下载WinSW的配置文件，配置相关参数：

• id为服务id
• name为服务名称（xml和exe的名称需要和name一致）
• description为服务描述
• env标签为环境变量，使用%NAME%引用环境变量，%BASE%代表当前 目录
• executable为执行的内容
• arguments为执行参数
• logpath为日志保存的目录（spring boot项目最好还是指定logback配置文件的位置，在logback文件内指定日志的位置）

<service>
  
  <id>sinoOCR</id>
  <!-- Display name of the service -->
  <name>sinoOCR</name>
  <!-- Service description -->
  <description>sinoOCR</description>
  
  <env name="JAVA_HOME" value="C:\\Program Files\\Java\\jdk1.8.0_202"></env>

  <!-- Path to the executable, which should be started -->
  <executable>java</executable>
  <arguments>-Dfile.encoding=utf-8 -Xms2048M -Xmx4096M -jar %BASE%\SinoOCR-Service-1.0.0.jar --logging.config=%BASE%\logback.xml --spring.profiles.active=prod --spring.config.location=%BASE%\application-prod.yml</arguments>
    
  <logpath>%BASE%\logs</logpath>
  <logmode>rotate</logmode>

</service>

配置完成后将下载的exe修改为和name一致。

2、配置logback的配置文件

注意：这里的log.path需要使用\转移，否则\t，\s等会被转义

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

    <!-- 日志存放路径 -->
	<property name="log.path" value="D:\\IdeaProjects\\SinoPythonService\\target\\logs" />
    <!-- 日志输出格式 -->
	<property name="log.pattern" value="%d{HH:mm:ss.SSS} [%thread] %-5level %logger{20} - [%method,%line] - %msg%n" />

	<!-- 控制台输出 -->
	<appender name="console" class="ch.qos.logback.core.ConsoleAppender">
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
	</appender>

	<!-- 系统日志输出 -->
	<appender name="file_info" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/sys-info.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
		<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
			<fileNamePattern>${log.path}/sys-info.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 180天 -->
			<maxHistory>180</maxHistory>
		</rollingPolicy>
		<encoder>
			<pattern>${log.pattern}</pattern>
		</encoder>
		<filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>INFO</level>
            <!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
            <!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
	</appender>

	<appender name="file_error" class="ch.qos.logback.core.rolling.RollingFileAppender">
	    <file>${log.path}/sys-error.log</file>
        <!-- 循环政策：基于时间创建日志文件 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 日志文件名格式 -->
            <fileNamePattern>${log.path}/sys-error.%d{yyyy-MM-dd}.log</fileNamePattern>
			<!-- 日志最大的历史 180天 -->
			<maxHistory>180</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 过滤的级别 -->
            <level>ERROR</level>
			<!-- 匹配时的操作：接收（记录） -->
            <onMatch>ACCEPT</onMatch>
			<!-- 不匹配时的操作：拒绝（不记录） -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

	<!-- 用户访问日志输出  -->
    <appender name="sys-user" class="ch.qos.logback.core.rolling.RollingFileAppender">
		<file>${log.path}/sys-user.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 按天回滚 daily -->
            <fileNamePattern>${log.path}/sys-user.%d{yyyy-MM-dd}.log</fileNamePattern>
            <!-- 日志最大的历史 180天 -->
            <maxHistory>180</maxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
	
	<!-- 系统模块日志级别控制  -->
	<logger name="com.sinosoft" level="info" />
	<!-- Spring日志级别控制  -->
	<logger name="org.springframework" level="warn" />

	<root level="info">
		<appender-ref ref="console" />
	</root>
	
	<!--系统操作日志-->
    <root level="info">
        <appender-ref ref="file_info" />
        <appender-ref ref="file_error" />
    </root>
	
	<!--系统用户操作日志-->
    <logger name="sys-user" level="info">
        <appender-ref ref="sys-user"/>
    </logger>
</configuration> 

3、启动命令

# 安装服务
./win install

# 卸载服务
./win unstall

# 启动服务
./winsw start

# 停止服务
./winsw stop

# 重启服务
./winsw restart

# 服务状态
./winsw status