Banner
使用 IDEA 编译器初始化一个 SpringBoot 项目,并尝试将项目在本地启动后,控制台会输出服务的启动信息,包括服务的 Banner 图案以及相关的日志信息。
默认 Banner
正如 SpringBoot 项目初始化 所配置的,初始化运行 SpringBoot 项目后,控制台会打印出如下的 Banner 信息。
- SpringBoot 默认 Banner 图内容,图中可见当前 SpringBoot 版本为 V2.7.6
Banner 配置
Banner 图案是 SpringBoot 服务启动时默认打印的日志内容,可以通过 SpringBoot 启动配置设置关闭 Banner 打印。
- 在启动类 main 方法中设置
application.setBannerMode(Banner.Mode.OFF)
,可以关闭 Banner 图。
如果认为 SpringBoot 项目启动 Banner 比较官方,并且代表使用的开发框架是 Spring,在实际进行项目开发时,我们可以根据需要切换为自己项目的图案,或者可以自定义为其他图案。
- 自定义 Banner 图案
自定义 Banner 流程
自定义项目启动 Banner 图案,只需要按照如下流程进行操作:
-
确定项目的 Banner 图案对应的字符串,如
spring
或spring-boot
-
在 ASCII Generator 或 degraeve.com 网站中生成字符串名称对应的 Banner 图案
- ASCII Generator 主要用来对文本字符生成 Banner 图案
- degraeve.com 则可以对引用图片生成对应的艺术图案
-
在项目的
src/main/resources
目录下新建 banner.txt 文件,将生成的图案结果复制到文件中 -
重新启动服务查看 Banner 信息
服务信息
日志打印服务信息
除了对项目 Banner 图自定义外,还可以在项目启动时控制台输出服务的基础信息,如服务名称、访问地址和端口号等信息。
通过打印的服务地址信息,可以方便的在日志中观察服务启动状态,并且在本地环境开发调试时直接访问对应服务地址。
本地 IDEA 中,可以直接点击地址或服务地址到浏览器中进行访问。
自定义输出配置
服务配置信息打印通过读取 SpringBoot 配置信息,并配合解析本地服务 ip 地址实现打印。
- 定义服务配置信息
yml
server:
port: 7001
spring:
application:
name: tools
- 启动时读取配置并打印输出
java
@SpringBootApplication
public class ToolsApplication {
private static Logger logger = LoggerFactory.getLogger(ToolsApplication.class);
public static void main(String[] args) throws UnknownHostException {
SpringApplication application = new SpringApplication(ToolsApplication.class);
ConfigurableApplicationContext applicationContext = application.run(args);
// 获取本地 ip 地址
String ip = InetAddress.getLocalHost().getHostAddress();
// 获取服务配置文件,name、port、以及全局服务路径
Environment env = applicationContext.getEnvironment();
String name = env.getProperty("spring.application.name");
String port = env.getProperty("server.port");
String path = Optional.ofNullable(env.getProperty("server.servlet.context-path")).orElse("");
// 打印输出
logger.info("\n----------------------------------------------------------\n\t" +
"Application " + name +" is running! Access URLs:\n\t" +
"Local 访问网址: \t\thttp://localhost:" + port + path + "\n\t" +
"External 访问网址: \thttp://" + ip + ":" + port + path + "\n\t" +
"----------------------------------------------------------");
}
}
- 启动服务,打印服务信息