运维实用篇
工程打包与运行
程序为什么要打包 ?
- 可以将程序部署在独立的服务器上
SpringBoot项目快速启动( Mac 版)
①:对 SpringBoot 项目打包(执行 Maven 构建指令 package)
- 执行 package 打包命令之前 先执行
clea
,删除target
目录及内容
- 打包完成 生成对应的 jar 文件
②:运行项目(执行启动指令) java -jar <打包文件名>
java -jar springboot_08_ssmp-0.0.1-SNAPSHOT.jar
注意事项:
jar 支持命令行启动需要依赖maven插件支持,请确认打包时是否具有 SpringBoot 对应的maven 插件
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
③:浏览器访问: http://localhost/pages/books.html
打包优化:跳过 test 生命周期
小结
- SpringBoot工程可以基于java环境下独立运行jar文件启动服务
- SpringBoot工程执行 mvn 命令 package 进行打包
- 执行jar命令:
java –jar 工程名.jar
打包插件
- 如果没有配置 SpringBoot 打包插件可能会遇到下面的问题:
- 使用 SpringBoot 提供的 maven 插件可以将工程打包成可执行jar包
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
jar包描述文件(MANIFEST.MF)
- 普通工程
Manifest-Version: 1.0
Implementation-Title: springboot_08_ssmp
Implementation-Version: 0.0.1-SNAPSHOT
Build-Jdk-Spec: 1.8
Created-By: Maven Jar Plugin 3.2.0
- 基于 spring-boot-maven-plugin 打包的工程
Manifest-Version: 1.0
Spring-Boot-Classpath-Index: BOOT-INF/classpath.idx
Implementation-Title: springboot_08_ssmp
Implementation-Version: 0.0.1-SNAPSHOT
Spring-Boot-Layers-Index: BOOT-INF/layers.idx
Start-Class: com.example.SSMPApplication 启动类
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk-Spec: 1.8
Spring-Boot-Version: 2.5.6
Created-By: Maven Jar Plugin 3.2.0
Main-Class: org.springframework.boot.loader.JarLauncher jar启动器
Boot工程快速启动(Linux版)
配置高级
临时属性(开发环境)
- 带属性启动 SpringBoot 程序,为程序添加运行属性
在启动类中 main 可以通过 System.out.println(Arrays.toString(args));
查看配置的属性
- 通过编程形式带参数启动 SpringBoot 程序,为程序添加运行参数
public static void main(String[] args) {
String[] arg = new String[1];
arg[0] = "--server.port=8080";
SpringApplication.run(SSMPApplication.class, arg);
}
- 不携带参数启动SpringBoot程序
public static void main(String[] args) {
// 可以在启动boot程序时断开读取外部临时配置对应的入口,
// 也就是去掉读取外部参数的形参
SpringApplication.run(SSMPApplication.class);
}
小结
- 启动SpringBoot程序时,可以选择是否使用命令行属性为SpringBoot程序传递启动属性
配置文件分类
SpringBoot 中4级配置文件
- 1级:
file:config/application.yml
【最高】 - 2级:
file:application.yml
- 3级:
classpath:config/application.yml
- 4级:
classpath:application.yml
【最低】
作用
- 1级与2级留做系统打包后设置通用属性,1级常用于运维经理进行线上整体项目部署方案调控
- 3级与4级用于系统开发阶段设置通用属性,3级常用于项目经理进行整体项目属性调控
思 考:
如果
yml
文件 与properties
文件 在不同层级中共存会是什么效果?例:类路径
application.properties
属性是否会覆盖文件系统 config 目录中的application.yml
属性
- properties 文件的优先级 大于 yml文件的优先级 (properties 文件会覆盖 yml 文件中的配置)
总结
- 配置文件分为 4 种
- 项目类路径配置文件:服务于开发人员本机开发与测试
- 项目类路径config目录中配置文件:服务于项目经理整体调控
- 工程路径配置文件:服务于运维人员配置涉密线上环境
- 工程路径config目录中配置文件:服务于运维经理整体调控
- 多层级配置文件间的属性采用叠加并覆盖的形式作用于程序
自定义配置文件
方式一
- 通过启动参数加载配置文件(无需书写配置文件扩展名)
--spring.config.name=ebank
properties
与yml
文件格式均支持
方式二
- 通过启动参数加载指定文件路径下的配置文件时可以加载多个配置,后面的会覆盖前面的
--spring.config.location=classpath:/ebank.yml,classpath:/ebank-server.yml
多配置文件常用于将配置进行分类,进行独立管理,或将可选配置单独制作便于上线更新维护
自定义配置文件——重要说明
- 单服务器项目:使用自定义配置文件需求较低
- 多服务器项目:使用自定义配置文件需求较高,将所有配置放置在一个目录中,统一管理
- 基于SpringCloud技术,所有的服务器将不再设置配置文件,而是通过配置中心进行设定,动态加载配置信息
小结
- 配置文件可以修改名称,通过启动参数设定
- 配置文件可以修改路径,通过启动参数设定
- 微服务开发中配置文件通过配置中心进行设置
总结
- SpringBoot在开发和运行环境均支持使用临时参数修改工程配置
- SpringBoot支持4级配置文件,应用于开发与线上环境进行配置的灵活设置
- SpringBoot支持使用自定义配置文件的形式修改配置文件存储位置
- 基于微服务开发时配置文件将使用配置中心进行管理
多环境开发
多环境开发(YAML版)
# 应用环境
# 公共配置
spring:
profiles:
active: dev
---
# 设置环境
# 生产环境
spring:
config:
activate:
on-profile: pro
server:
port: 80
---
# 开发环境
spring:
config:
activate:
on-profile: dev
server:
port: 81
---
# 测试环境
spring:
config:
activate:
on-profile: test
server:
port: 82
小结
- 多环境开发需要设置若干种常用环境,例如开发、生产、测试环境
- yaml格式中设置多环境使用—区分环境设置边界
- 每种环境的区别在于加载的配置属性不同
- 启用某种环境时需要指定启动时使用该环境
多环境开发(YAML版)多配置文件格式
- 主启动配置文件
application.yml
# 应用环境
spring:
profiles:
active: dev
- 环境分类配置文件
application-pro.yml
server:
port: 8080
- 环境分类配置文件
application-dev.yml
server:
port: 8081
- 环境分类配置文件
application-test.yml
server:
port: 8082
多环境开发配置文件书写技巧(一)
- 主配置文件中设置公共配置(全局)
- 环境分类配置文件中常用于设置冲突属性(局部)
小结
- 可以使用独立配置文件定义环境属性
- 独立配置文件便于线上系统维护更新并保障系统安全性
多环境开发多文件版(Properties版)
- 主启动配置文件
application.properties
spring.profiles.active=dev
- 环境分类配置文件
application-pro.properties
server.port=9080
- 环境分类配置文件
application-dev.properties
server.port=9081
- 环境分类配置文件
application-test.properties
server.port=9082
小结
- properties 文件多环境配置仅支持多文件格式
多环境开发独立配置文件书写技巧(二)
根据功能对配置文件中的信息进行拆分,并制作成独立的配置文件,命名规则如下:
application-devDB.yml
application-devRedis.yml
application-devMVC.yml
使用 include 属性在激活指定环境的情况下,同时对多个环境进行加载使其生效,多个环境间使用逗号分隔
spring:
profiles:
active: dev
include: devMVC,devDB
- 当主环境 dev 与其他环境有相同属性时,主环境属性生效;其他环境中有相同属性时,最后加载的环境属性生效
- 主环境不管放在什么顺序都是生效的,其他环境按最后加载的生效
The following 3 profiles are active: "devMVC", "devDB", "dev"
从Spring2.4版开始使用 group 属性替代 include 属性,降低了配置书写量
- 使用group属性定义多种主环境与子环境的包含关系
spring:
profiles:
active: dev
group:
"dev": devDB,devMVC
"pro": proDB,proMVC
"test": testDB,testRedis,testMVC
- 使用group属性,会覆盖 主环境dev (active) 的内容,最后加载的环境属性生效
The following 3 profiles are active: "dev", "devDB", "devMVC"
小结
- 多环境开发使用group属性设置配置文件分组,便于线上维护管理
多环境开发控制
Maven 与 SpringBoot 多环境兼容
①:Maven中设置多环境属性
<!--Maven中设置多环境属性-->
<profiles>
<profile>
<id>env_dev</id>
<properties>
<profile.active>dev</profile.active>
</properties>
<activation>
<activeByDefault>true</activeByDefault>
</activation>
</profile>
<profile>
<id>env_pro</id>
<properties>
<profile.active>pro</profile.active>
</properties>
</profile>
</profiles>
②:SpringBoot 中引用Maven属性
spring:
profiles:
active: @profile.active@
group:
"dev": devDB,devMVC
"pro": proDB,proMVC
③:执行 Maven 打包指令,并在生成的boot打包文件 .jar
文件中查看对应信息
- 问题:修改
pom.xml
文件后,启动如果没有生效,手动compile
即可
- 或者设置 IDEA进行自动编译
小结
- 当Maven与SpringBoot同时对多环境进行控制时,以Mavn为主,SpringBoot使用 @…@ 占位符读取Maven对应的配置属性值
- 基于SpringBoot读取Maven配置属性的前提下,如果在Idea下测试工程时pom.xml每次更新需要手动compile方可生效
日志
日志基础操作
- 日志(log)作用
- 编程期调试代码
- 运营期记录信息
- 记录日常运营重要信息(峰值流量、平均响应时长……)
- 记录应用报错信息(错误堆栈)
- 记录运维过程数据(扩容、宕机、报警……)
代码中使用日志工具记录日志
①:添加日志记录操作
// Rest 模式
@RestController
@RequestMapping("/books")
public class BookController {
// 创建记录日志的对象
private static final Logger log = LoggerFactory.getLogger(BookController.class);
@GetMapping
public String getById() {
System.out.println("springboot is running...");
log.debug("debug ...");
log.info("info ...");
log.warn("warn ...");
log.error("error ...");
return "spring is running...";
}
}
日志级别
- TRACE:运行堆栈信息,使用率低
- DEBUG:程序员调试代码使用
- INFO:记录运维过程数据
- WARN:记录运维过程报警数据
- ERROR:记录错误堆栈信息
- FATAL:灾难信息,合并计入ERROR
②:设置日志输出级别
# 开启 debug 模式,输出调试信息,常用于检查系统运行状况
debug: true
# 设置日志级别, root 表示根节点,即整体应用日志级别
logging:
level:
root: debug
③:设置日志组,控制指定包对应的日志输出级别,也可以直接控制指定包对应的日志输出级别
# 设置日志级别, root 表示根节点,即整体应用日志级别
logging:
# 设置分组
group:
ebank: cn.xx.controller,cn.xx.service,cn.xx.dao
iservice: com.alibaba
level:
root: info
# 设置某个包的日志级别
# cn.xx.controller: debug
# 设置分组,对某个组设置日志级别
ebank: warn
小结
- 日志用于记录开发调试与运维过程消息
- 日志的级别共6种,通常使用4种即可,分别是DEBUG,INFO,WARN,ERROR
- 可以通过日志组或代码包的形式进行日志显示级别的控制
教你一招:快速创建日志对象
- 先引入 Lombok 工具类
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
- 使用 lombok 提供的注解 @Slf4j 简化开发,减少日志对象的声明操作
@Slf4j
// Rest 模式
@RestController
@RequestMapping("/books")
public class BookController {
@GetMapping
public String getById() {
System.out.println("springboot is running...");
log.debug("debug ...");
log.info("info ...");
log.warn("warn ...");
log.error("error ...");
return "spring is running...";
}
}
小结
- 基于lombok提供的@Slf4j注解为类快速添加日志对象
日志输出格式控制
- PID:进程ID,用于表明当前操作所处的进程,当多服务同时记录日志时,该值可用于协助程序员调试程序
- 所属类/接口名:当前显示信息为 SpringBoot 重写后的信息,名称过长时,简化包名书写为首字母,甚至直接删除
设置日志输出格式
# 设置日志的模板格式
logging:
pattern:
console: "%d - %m %n"
%d
:日期%m
:消息%n
:换行
# 设置日志的模板格式
pattern:
# console: "%d - %m %n"
console: "%d %clr(%5p) --- [%16t] %clr(%-40.40c){cyan} : %m %n"
小结
- 日志输出格式设置规则
文件记录日志
- 设置日志文件
logging:
file:
name: server.log
- 日志文件详细配置
logging:
file:
name: server.log
logback:
rollingpolicy:
max-file-size: 4KB
file-name-pattern: server.%d{yyyy-MM-dd}.%i.log
小结
- 日志记录到文件
- 日志文件格式设置