Spring Boot - 启动彩蛋.md

引用

https://docs.spring.io/spring-boot/docs/current/reference/html/boot-features-spring-application.html
本文 Spring Boot 版本为 2.1.0.RELEASE
Spring Boot 彩蛋的关键词为 Spring Boot Banner

---

彩蛋

当我们启动 Spring Boot 的时候,会发现 console 中会打印 Spring Boot 的彩蛋 . 如 :

  . ____ _ __ _ _
 /\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
 \\/ ___)| |_)| | | | | || (_| | ) ) ) )
  ' |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot :: (v2.1.0.RELEASE)

关闭彩蛋

在application.yml 中关闭 , 请务必注意双引号 :

spring:
  main:
    banner-mode: "off"

或者在启动类中关闭 :

   public static void main(String[] args) {
        SpringApplication springApplication = new SpringApplication(WebApplication.class);
        springApplication.setBannerMode(Banner.Mode.OFF);
        springApplication.run(args);
    }

---

自定义彩蛋

第一种方法: 直接在 resource 目录下创建名为 banner.txt 文件 (你也可以通过 spring.banner.location = path 来指定文件其他的位置) , banner.txt 中指定内容如下 :

Hello Spring Boot !
我是一个可爱的文件

启动时候便会输出

Hello Spring Boot !
我是一个可爱的文件

如果你想在 banner 中使用相应的版本号可以这样写 , banner.txt 内容如下 :

Hello Spring Boot !
我是一个可爱的文件

application.version : ${application.version}
application.formatted-version : ${application.formatted-version}
spring-boot.version : ${spring-boot.version}
spring-boot.formatted-version : ${spring-boot.formatted-version}
application.title : ${application.title}

当你用 IDE 启动的时候你会发现,输出如下 , 没有获取到应用的 version 以及 title

application.version : 
application.formatted-version : 
spring-boot.version : 2.1.0.RELEASE
spring-boot.formatted-version : (v2.1.0.RELEASE)
application.title : 

${application.version} 和 ${application.title} 这样的占位符是读取自 MANIFEST.MF , 也就是说这两个属性只能在启动可执行 Jar或者 可执行 war 文件的时候才后输出,
使用 IDE 启动的时候无法看到 . 因此你可以在 build.gradle 中配置, 以下配置二选一 :

// 如果你使用的是可执行 war 
bootWar {
    manifest {
        attributes("Implementation-Title": project.name,
                "Implementation-Version": version
        )
    }
}
// 如果你使用的是可执行 Jar 
bootJar {
    manifest {
        attributes("Implementation-Title": project.name,
                "Implementation-Version": version
        )
    }
}

启动 jar 包 :

java -jar web-0.0.1-SNAPSHOT.jar

这个时候你就能看到版本号

Hello Spring Boot !
我是一个可爱的文件

application.version : 0.0.1-SNAPSHOT
application.formatted-version : (v0.0.1-SNAPSHOT)
spring-boot.version : 2.1.0.RELEASE
spring-boot.formatted-version : (v2.1.0.RELEASE)
application.title : web

---

设置彩蛋方法二

在代码中动态设置 ,需要实现 Banner 接口 , 简单例子如下 :

    public static void main(String[] args) {
        SpringApplication springApplication = new SpringApplication(WebApplication.class);
        springApplication.setBanner(new Banner() {
            @Override
            public void printBanner(Environment environment, Class<?> sourceClass, PrintStream out) {
                out.println("hello world");
            }
        });
        springApplication.run(args);
    }

则启动的时候只有以下彩蛋输出 :

hello world !

想要更复杂的实现 ,可参考 Banner 的实现类 , ResourceBanner 、 SpringBootBanner 等 .

彩蛋中显示图片(没卵用)

在 application.yaml 中指定图片的位置 、显示图片的 width 、height , 例如在 resources 目录下的我一张 自拍 zipai.jpg

spring:
  banner:
    image:
      location: zipai.jpg

输出基本等于毁容, 显示结果如下 :

  &&&&&&&&ooooooooo::::::::::::****************************************:::::::
  &&&&&&&ooooooooo:::::::::::****************..***************************::::
  &&&&&&ooooooooo:::::::::************..:*.****.....***********************:::
  &&&&&oooooooo::::::::*********8@@@#@@@@@@@@@*............******************:
  &&&&oooooooo::::::::********@@@@@@@@@@@@@@@@@@#.............****************
  &&&oooooooo::::::::********@@@@@@@@@@@@@@@@@@@@:................************
  &&&oooooooo:::::::::******@@@@@@@&*****::o#@@@@@o...............************
  &&oooooooo::::::::::*****.@@@@@@*......**:o8#@@@@..................*********
  &&oooooooo:::::::::******.@@@#@#*.......*:o8#@@@@.................**********
  &&oooooo::::::::::*******.@@@8&...... .*:ooo8#@@o..................*********
  &&ooooooo:::::::::*******:..##*...*.*&8##oo&#@@@...................*********
  &&oooooooo::::::::********o8*o*...**#*&#.*@@@@@o.....................*******
  &&ooooooo::::::*:********.o**:**....**...*8@@@@.....................********
  &&oooooooo::::::::*******..*:***.....**...&@@#@......................*******
  &&oooooooo::::::::********.&:**.....*&oo@*#@@@ .....................********
  &&oooooooo:::::::::********o::*......*..*:@@@@.......................*******
  &&&oooooooo:::::::*******@@o**:*****o*:o#@@@@......................*********
  &&&ooooooooo:::::::****:o@@#***oo:**..:&&#@@.......................*********
  &&&&oooooooo::::::::**:oo:o####::&8o**:o8#o......................***********
  &&&&ooooooooo::::::::ooooooo&####@88...***::**o#............****************
  &&&&&ooooooooo:::::&o&&&&&oooo@#@@@@@.*.:.*.**:*o.........******************
  &&&&&&ooooooooo:o&ooo&&8&&&&&&&&@@@@@ &.o***@@o.8@.*.**********************:
  &&&&&&&oooooooooo:oooo&&8&&#88&&&#@@@@@:&:##@@..:#************************::
  &&&&&&&&oooooo:::::o&o&&&8888#888&8@@@@@@o:8:**.:#@@.*****************::::::
  &&&&&&&&&&oo::::*::::ooo&&&8#888##88@@@@@@@8o:.*&##@@8**************::::::::
  8&&&&&&&&&&&:o::::::::ooo&#&&8#88#@##@@@@#@@@@#88o88#@@********:::::::::::::
  88&&&&&&&&&o:::::o&&:oo&&88#@&&#@@#@@#@@@@@@@@@@:*@@@@@#::**::::::::::::::::
  888&&&&&&&&&&:ooo:o&#&o&&88#@@#&8@@#@@@@@@#@#@@@@@@@@@#@@&::::::::::::::::::
  88888&&&&&&&::oo88oo::ooo8#@@@@8&&#@@@@@@@8@#####o@@8@@@@@@::::::::::::::ooo
  888888&&&&&o&&8#@@@#8oooo88#@@@@#8&#@@@@@@@@#########@@@@@@@:::::::::::ooooo
  88888888&&&ooooooo::oooo&&&&8##@@8&8@@@@@@@#@#8@######@@@@@@@:::::oooooooooo
  888888888&&o&ooooo:::::&oo&&88##@@#&&@@@@@@@@#8####8###@@@@@@@oooooooooooooo
  88888888888&&&oooo:::::::o:oo&8##@@#8@@@@@@@@#8##@8#8###@@@@@@@8ooooooooooo&
  888888888888&&&&oo:::o:::::ooo&88#@@8#@@@@@@@@##@@@8##8#@@@@@#@@@oooooooo&&&
  8888888888888oo&&oooo:::::::oo&&8##@@@@@@@@@@@#@@@@##8#@@@@@@#@@@oooo&&&&&&&
  88888888888888&o8&ooo:::::::o&&88##@@@@@@@@@@@@@@@@@8@###@@@@@@@@#&&&&&&&&&&
  ##888888888888&&&&8oo:oo::oo::ooooo&@@@@@@@@@@@@##@@@@8##@@@@@@@@@&&&&&&&&&&
  ####88888888888&&8&#&oooo::ooooooo8@@@8##8@##&88@#@@@@@@@@@@@@@#@@&&&&&&&&&&
  ######8888888888&&8&88&oooooooooo&@@#8##@@#######@@#@@@@@@@@@@@@@&&&&&&&&888
  #########8888888&&8&&&#8&ooo&&o&o&#&#@8#@@@@@@@@8@@@@@@@@@@@@@@&&88888888888
  #############8888&&&88o&88&oo&&&&&88@@&#@@@@@@@@@@@@@@@@@8888888888888888888
  ################88&&8o&&&8&8&oo&&&&8###@@@@@@@@@@@@@@@@@88888888888888888888
  #################8&8&&&&&&&8&&&&&&&88@@@@@@@@@@@@@@@@@@@88888888888888888888
  ##################8&&&&&&oo8&888#&&8&#@@@@@@@@@@@@@@@@@#88888888888888888888
  ###################&o&ooooo&oo8888#@@@@@@@@@@@@@@@@@@88888888888888888888888
  #########*#########&&&oooooooo&&&8#@@@@@@@@@@@@@@@@@@88888888888############
  ####*##8#:****#**##&&#&ooo&&&&&&&&&&&8##@@@@@@@@@@@@@#######################
  ###################8&&oooo&&&&&&888&888#####@@@@@@&@@@######################
  ##################&&&&&ooo&&&&8&&&88888####@@@@@@@@@@@######################
  @@#@#############8&&&&8@8&oo&&&8888#@@###@#@@@@@@@@@@@######################