|
| 1 | +# 前言 |
| 2 | + |
| 3 | +我们肯定很好奇,当我们启动 springboot 的时候,这个下面的 banner 是怎么打印出来的呢? |
| 4 | + |
| 5 | + |
| 6 | + |
| 7 | + 以及我们可不可以定制我们自己的banner,那我们就进入一下 SpringBoot 的源码,看下他是怎么加载的吧 |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +# 源码分析 |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +## 项目结构 |
| 16 | + |
| 17 | + |
| 18 | + |
| 19 | +## 入口 |
| 20 | + |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | + |
| 25 | + |
| 26 | + |
| 27 | + |
| 28 | + |
| 29 | +```java |
| 30 | +private Banner printBanner(ConfigurableEnvironment environment) { |
| 31 | + // 判断是否关闭了 banner 打印模式 |
| 32 | + if (this.bannerMode == Banner.Mode.OFF) { |
| 33 | + return null; |
| 34 | + } |
| 35 | + // 初始化资源加载器 |
| 36 | + ResourceLoader resourceLoader = (this.resourceLoader != null) |
| 37 | + ? this.resourceLoader : new DefaultResourceLoader(getClassLoader()); |
| 38 | + // 初始化 banner 打印对象 |
| 39 | + SpringApplicationBannerPrinter bannerPrinter = new SpringApplicationBannerPrinter( |
| 40 | + resourceLoader, this.banner); |
| 41 | + // 如果在 log中打印 banner |
| 42 | + if (this.bannerMode == Mode.LOG) { |
| 43 | + return bannerPrinter.print(environment, this.mainApplicationClass, logger); |
| 44 | + } |
| 45 | + // 如果在 控制台打印banner |
| 46 | + return bannerPrinter.print(environment, this.mainApplicationClass, System.out); |
| 47 | +} |
| 48 | +``` |
| 49 | + |
| 50 | +```java |
| 51 | +// 只有三种模式,关闭 控制台 和log文件中 |
| 52 | +enum Mode { |
| 53 | + |
| 54 | + /** |
| 55 | + * Disable printing of the banner. |
| 56 | + */ |
| 57 | + OFF, |
| 58 | + |
| 59 | + /** |
| 60 | + * Print the banner to System.out. |
| 61 | + */ |
| 62 | + CONSOLE, |
| 63 | + |
| 64 | + /** |
| 65 | + * Print the banner to the log file. |
| 66 | + */ |
| 67 | + LOG |
| 68 | + |
| 69 | +} |
| 70 | +``` |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | + |
| 76 | +```java |
| 77 | +public Banner print(Environment environment, Class<?> sourceClass, PrintStream out) { |
| 78 | + // 获取banner,看了这个我们就知道怎么去更改 banner了 |
| 79 | + Banner banner = getBanner(environment); |
| 80 | + // 打印 banner |
| 81 | + banner.printBanner(environment, sourceClass, out); |
| 82 | + return new PrintedBanner(banner, sourceClass); |
| 83 | +} |
| 84 | +``` |
| 85 | + |
| 86 | +```java |
| 87 | +private Banner getBanner(Environment environment) { |
| 88 | + // 创建一个局部对象 Banners ,这个对象继承自 Banner接口,内容很简单,保存banner信息,添加banner方法,打印banner方法 |
| 89 | + Banners banners = new Banners(); |
| 90 | + // 添加banner ,这个里面还有些道道 |
| 91 | + banners.addIfNotNull(getImageBanner(environment)); |
| 92 | + banners.addIfNotNull(getTextBanner(environment)); |
| 93 | + if (banners.hasAtLeastOneBanner()) { |
| 94 | + return banners; |
| 95 | + } |
| 96 | + if (this.fallbackBanner != null) { |
| 97 | + return this.fallbackBanner; |
| 98 | + } |
| 99 | + // 如果都没有,那么就会打印默认的 banner, 我们都见过 |
| 100 | + return DEFAULT_BANNER; |
| 101 | +} |
| 102 | +``` |
| 103 | + |
| 104 | +```java |
| 105 | +// 获取 图像banner 信息 |
| 106 | +private Banner getImageBanner(Environment environment) { |
| 107 | + // 获取配置文件中的 banner 位置信息 |
| 108 | + String location = environment.getProperty(BANNER_IMAGE_LOCATION_PROPERTY); |
| 109 | + if (StringUtils.hasLength(location)) { |
| 110 | + Resource resource = this.resourceLoader.getResource(location); |
| 111 | + return resource.exists() ? new ImageBanner(resource) : null; |
| 112 | + } |
| 113 | + // 如果配置文件中没有指明,我们就读取默认的配置,banner前缀开头的,挨个遍历匹配。按照 gif。jpg、png的顺序,所以如果匹配到前面的图片,后面的就不会显示 |
| 114 | + for (String ext : IMAGE_EXTENSION) { |
| 115 | + Resource resource = this.resourceLoader.getResource("banner." + ext); |
| 116 | + if (resource.exists()) { |
| 117 | + return new ImageBanner(resource); |
| 118 | + } |
| 119 | + } |
| 120 | + return null; |
| 121 | + } |
| 122 | +``` |
| 123 | + |
| 124 | +```java |
| 125 | +// 默认的 banner |
| 126 | +class SpringBootBanner implements Banner { |
| 127 | + |
| 128 | + private static final String[] BANNER = { "", |
| 129 | + " . ____ _ __ _ _", |
| 130 | + " /\\\\ / ___'_ __ _ _(_)_ __ __ _ \\ \\ \\ \\", |
| 131 | + "( ( )\\___ | '_ | '_| | '_ \\/ _` | \\ \\ \\ \\", |
| 132 | + " \\\\/ ___)| |_)| | | | | || (_| | ) ) ) )", |
| 133 | + " ' |____| .__|_| |_|_| |_\\__, | / / / /", |
| 134 | + " =========|_|==============|___/=/_/_/_/" }; |
| 135 | + |
| 136 | + private static final String SPRING_BOOT = " :: Spring Boot :: "; |
| 137 | + |
| 138 | + private static final int STRAP_LINE_SIZE = 42; |
| 139 | + |
| 140 | + @Override |
| 141 | + public void printBanner(Environment environment, Class<?> sourceClass, |
| 142 | + PrintStream printStream) { |
| 143 | + for (String line : BANNER) { |
| 144 | + printStream.println(line); |
| 145 | + } |
| 146 | + String version = SpringBootVersion.getVersion(); |
| 147 | + version = (version != null) ? " (v" + version + ")" : ""; |
| 148 | + StringBuilder padding = new StringBuilder(); |
| 149 | + while (padding.length() < STRAP_LINE_SIZE |
| 150 | + - (version.length() + SPRING_BOOT.length())) { |
| 151 | + padding.append(" "); |
| 152 | + } |
| 153 | + |
| 154 | + printStream.println(AnsiOutput.toString(AnsiColor.GREEN, SPRING_BOOT, |
| 155 | + AnsiColor.DEFAULT, padding.toString(), AnsiStyle.FAINT, version)); |
| 156 | + printStream.println(); |
| 157 | + } |
| 158 | + |
| 159 | +} |
| 160 | +``` |
| 161 | + |
| 162 | +# 实验 |
| 163 | + |
| 164 | +我们准备了 四个文件,gif、jpg、png、txt。打印出来是这样的,上面是 gif的内容,下面是 txt的内容 |
| 165 | + |
| 166 | + |
| 167 | + |
| 168 | + |
| 169 | + |
| 170 | +我们在配置文件中指定文件,就不会按照默认的来进行显示了 |
| 171 | + |
| 172 | + |
| 173 | + |
| 174 | + |
| 175 | + |
0 commit comments