写点什么

从零开始:编写个性化的 Spring Boot 启动 Banner

作者:Liam
  • 2024-01-24
    广东
  • 本文字数:2027 字

    阅读完需:约 7 分钟

从零开始:编写个性化的 Spring Boot 启动 Banner

Spring Boot 应用的初启页面展示独特的 ASCII 艺术品能够为您的应用增添特色,并为用户或开发者提供温馨的问候。这种 ASCII 图案常常蕴含着项目的名称、版本信息、以及作者等重要数据。除此之外,这样的欢迎页面还起到加强品牌形象的作用。


自定义启动画面的益处包括但不限于:


  • 品牌印象深化:展示有创意的 ASCII 图案,提升用户与项目的互动体验。

  • 问候语:通过动人的问候词,传达应用的关键信息。

  • 版本与作者信息:便于迅速辨识当前运行的应用版本以及开发者信息。

一、启动画面的有效运用

以下情形下,自定义 Spring Boot 的启动画面尤为有效:


  • 提升项目形象:自定义启动画面通过欢迎信息来展现项目的个性。

  • 版本辨识:在不同环境部署时,通过启动画面上的版本信息快速识别。

  • 开发团队交流:在启动画面展现团队和作者信息,增强团队归属感。

二、配置自定义启动画面

在 Spring Boot 中激活自定义的启动画面,你需要进行以下操作:


  1. 在项目的src/main/resources目录下创建名为banner.txt的文本文件。

  2. 用在线工具生成符合你项目风格的 ASCII 图形,并写入到banner.txt中。

  3. 要覆盖默认的 Spring Boot 启动画面,在application.propertiesapplication.yml配置中加入以下代码:


spring.banner.location=classpath:banner.txt
复制代码


或者你可以在 Spring Boot 的主运行函数中这样操作:


SpringApplication app = new SpringApplication(YourApplication.class);app.setBannerMode(Banner.Mode.CONSOLE);app.run(args);
复制代码


  1. 现在启动你的项目,就能看到定制的启动画面了。

三、示例

这是一个banner.txt示例内容:


    .   ____          _            __ _ _   /\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \  ( ( )___ | '_ | '_| | '_ / _` | \ \ \ \   \/  ___)| |_)| | | | | || (_| |  ) ) ) )    '  |____| .__|_| |_|_| |___, | / / / /   =========|_|==============|___/=/_/_/_/   :: Spring Boot ::       (v2.1.3.RELEASE)
Welcome to the Sample ProjectVersion: 2.1.3.RELEASEDesigner: Your Team
复制代码


确保该文件保存在正确的文件夹内,并按照前述步骤操作,以激活自定义的启动画面。

四、进阶:自制 Spring Boot 启动画面

1. 彩色 ASCII 图案

你可以给 ASCII 图案添加彩色效果,让启动画面更为醒目。例如,使用 ANSI 色彩码给文本上色:


\e[34m    .   ____          _            __ _ _\e[32m   /\ / ___'_ __ _ _(_)_ __  __ _ \ \ \ \\e[36m  ( ( )___ | '_ | '_| | '_ / _` | \ \ \ \\e[35m   \/  ___)| |_)| | | | | || (_| |  ) ) ) )\e[31m    '  |____| .__|_| |_|_| |___, | / / / /\e[33m   =========|_|==============|___/=/_/_/_/   :: Spring Boot ::       (v2.1.3.RELEASE)\e[0m
复制代码


在此例中\e[34m设定蓝色字体,\e[0m则将字体颜色重置为默认。

2. 利用图形工具生成启动画面

存在多款在线工具可用于生成复杂的 ASCII 图案,如ASCII Art Generator,生成后直接复制粘贴至你的banner.txt

3. 根据条件展现不同的启动画面

Spring Boot 允许基于特定条件展示不同的启动画面。在不同的配置文件中指定不同的启动画面即可:


spring.profiles.active=devspring.banner.location=classpath:banner-dev.txt
复制代码


在此示例中,如果当前激活的配置是"dev",那么就会展示名为banner-dev.txt的启动画面。

4. 编码自定义启动画面

更加灵活的定制选项是通过 Java 代码实现Banner接口自定义启动画面,例如:


import org.springframework.boot.Banner;import org.springframework.core.env.Environment;import java.io.PrintStream;
public class MyBanner implements Banner {
@Override public void printBanner(Environment environment, Class<?> sourceClass, PrintStream printStream) { printStream.println("======================================"); printStream.println("= MY APPLICATION ="); printStream.println("= POWERED BY SPRING BOOT ="); printStream.println("======================================"); }}
复制代码


以上示例中自定义的MyBanner会在启动时打印出独特的版头。

五、接口测试与管理

面对复杂的 API 接口,JAVA 开发者可能会需要一个强大的接口测试工具,这样的工具应该能够全面覆盖接口测试、模拟以及管理。Apifox 整合了接口测试的诸多功能,比如 HTTP(S), WebSocket, Socket, gRPC, Dubbo 等协议的接口调试,并通过 IDEA 插件同步生成接口文档,这对于开发维护来说极为方便。

六、注意事项

自定义启动画面时请注意:


  • 确保banner.txt放置于src/main/resources文件夹中。

  • 避免过于复杂的 ASCII 图案,以保证启动画面的清晰度。

  • 配置自定义启动画面时确保正确指定文件路径和名称。


知识扩展:



参考链接:


  • Spring Boot Banner: https://docs.spring.io/spring-boot/docs/current/reference/html/features.html#features.spring-application.banner

用户头像

Liam

关注

没有一个bug是无辜的! 2021-12-23 加入

一个简单的程序员!

评论

发布
暂无评论
从零开始:编写个性化的 Spring Boot 启动 Banner_Java_Liam_InfoQ写作社区