SpringBoot:使用小技巧合集_ico

作者:謝謝同学

前言

最近工作比较忙,事情也比较多。加班回到家都十点多了,洗个澡就想睡觉了。所以为了不断更太多天,偷懒写个小技巧合集吧。之后有时间都会进行文章更新的。原创不易,码字不易,还希望大家多多支持!话不多说,开始今天的技巧合集吧~

  • 设置网站图标

  • 允许跨域访问

  • 独立Tomcat运行

  • 启动不设置端口

  • 启动完成前进行业务逻辑

  • 动态修改日志级别

  • 热部署

  • 自定义启动Banner

    • 文字形式

    • 图片形式

  • 相关资料

  • 总结

  • 一点吐槽

  • 最后

  • 老生常谈

设置网站图标

原来我们在使用 tomcat开发时,设置网站图片时,即icon图标时,一般都是直接替换 root包下的 favicon.ico替换成自己的,或者在网页的头部设置 link的ref为 icon然后设置其 href值。而在 SpringBoot中,替换图片也是很简单的,只需要将自定义图片放置在 静态资源目录下即可,即默认有 staticpublicresources/META-INF/resources或者自定义的静态目录下即可。

目录结构:

SpringBoot:使用小技巧合集_mvc_02

SpringBoot:使用小技巧合集_tomcat_03

允许跨域访问

CORS是一个W3C标准,全称是"跨域资源共享"(Cross-origin resource sharing)。它允许浏览器向跨源(协议 + 域名 + 端口)服务器,发出XMLHttpRequest请求,从而克服了AJAX只能同源使用的限制。

简单来说,跨域问题是可以通过 nginx来解决的,或者通过 jsonp(只支持get请求)来解决。而 SpringBoot中也提供了配置方法。 0.利用 @CrossOrigin注解,可放至在类上或者方法上。类上代表整个控制层所有的映射方法都支持跨域请求。

  1.  
  2. @CrossOrigin
    (
    origins 
    =
     
    "http://blog.lqdev.cn"
    ,
     maxAge 
    =
     
    3600
    )
    
    @RestController
    
    public
     
    class
     demoController
    {
    
       
    @GetMapper
    (
    "/"
    )
    
       
    public
     
    String
     index
    (){
    
          
    return
     
    "hello,CORS"
    ;
    
       
    }
    
    }

     

1.配置全局 CORS配置。官网也有给出实例,具体如下:

  1. @Configuration
    
    public
     
    class
     
    MyConfiguration
     
    {
    
        
    @Bean
    
        
    public
     
    WebMvcConfigurer
     corsConfigurer
    ()
     
    {
    
            
    return
     
    new
     
    WebMvcConfigurerAdapter
    ()
     
    {
    
                
    @Override
    
                
    public
     
    void
     addCorsMappings
    (
    CorsRegistry
     registry
    )
     
    {
                
    
                         registry
    .
    addMapping
    (
    "/api/**"
    ).
    allowedOrigins
    (
    "https://blog.lqdev.cn"
    );
    
                
    }
    
            
    };
    
        
    }
    
    }


独立Tomcat运行

讲解了这么久,一般上我们都是通过jar包的方式进行启动的应用的。所以部署在独立的 tomcat时,需要如何解决呢?其实也简单,只需要将项目打包方式修改为 war包,然后修改下启动类配置即可。

0.修改pom打包方式为 war,同时排除了内置的 tomcat

  1. <

    packaging>
    war
    </packaging>
    
    <!-- 排除内置的tomcat -->
    
            
    <dependency>
    
                
    <groupId>
    org.springframework.boot
    </groupId>
    
                
    <artifactId>
    spring-boot-starter-tomcat
    </artifactId>
    
                
    <scope>
    compile
    </scope>
    
            
    </dependency>
    
    <!-- 若直接有使用servlet对象时(这是废话,⊙﹏⊙‖∣),需要将servlet引入,本例是没有的~ -->
    
           
    <dependency>
    
              
    <groupId>
    javax.servlet
    </groupId>
    
              
    <artifactId>
    javax.servlet-api
    </artifactId>
    
              
    <scope>
    provided
    </scope>
    
           
    </dependency


    >

1.改造下启动类,使其继承 SpringBootServletInitializer,同时覆盖 configure方法。

  1. SpringBootApplication
    
    @Slf4j
    
    public
     
    class
     
    ChapterApplication
     
    extends
     
    SpringBootServletInitializer
    {
    
        
    public
     
    static
     
    void
     main
    (
    String
    []
     args
    )
     
    {
    
            
    SpringApplication
    .
    run
    (
    ChapterApplication
    .
    class
    ,
     args
    );
    
        
    //    new SpringApplicationBuilder().sources(ChapterApplication.class).web(false).run(args);
    
        
    //之后这里设置业务逻辑 比如挂起一个线程 或者设置一个定时任务。保证不退出
    
            
    //不然它就是一个启动类,启动后就停止了。
    
            log
    .
    info
    (
    "jar,chapter启动!"
    );
    
        
    }
     
    
        
    @Override
    
        
    protected
     
    SpringApplicationBuilder
     configure
    (
    SpringApplicationBuilder
     application
    )
     
    {
    
            log
    .
    info
    (
    "外部tomcat,chapter启动!"
    );
    
            
    return
     application
    .
    sources
    (
    ChapterApplication
    .
    class
    );
    
        
    }
    
    }


    2.maven打包成war( mvn clean install),然后放入tomcat中,启动运行即可。

SpringBoot:使用小技巧合集_spring_04

其实这样设置的话,在开发时直接运行启动类也还是可以直接运行的,方便.

SpringBoot:使用小技巧合集_tomcat_05

启动不设置端口

对一些定时任务服务项目,其本身只是提供一个定时调度功能,不需要其他服务调用,只是去调度其他服务。像这样的服务,正常也就不需要设置端口了。这时候 SpringBoot也是支持的。只需要改下启动方式:

  1.  
  2. new
     
    SpringApplicationBuilder
    ().
    sources
    (
    ChapterApplication
    .
    class
    ).
    web
    (
    false
    ).
    run
    (
    args
    );
    
    //之后这里设置业务逻辑 比如挂起一个线程 或者设置一个定时任务。保证不退出
    
    //不然它就是一个启动类,启动后就停止了。

     

或者修改配置文件的属性:

  1. spring.main.web-environment=false

最后效果,是不是没有看见端口了:

SpringBoot:使用小技巧合集_tomcat_06

 

启动完成前进行业务逻辑

利用 CommandLineRunner或者 ApplicationRunner可实现在 SpringApplicationrun()完成前执行一些业务逻辑

0.修改启动类,实现 CommandLineRunner接口, ApplicationRunner类似,只是 run的入参不同而已。

  1.  
  2. @Override
    
        
    public
     
    void
     run
    (
    String
    ...
     args
    )
     
    throws
     
    Exception
     
    {
    
            log
    .
    info
    (
    "CommandLineRunner运行"
    );
    
        


    }

1.运行应用,注意查看控制台输出:

SpringBoot:使用小技巧合集_自定义_07

当然,直接申明一个 bean也是可以的。

  1.  
  2. @Configuration
    
    @Slf4j
    
    public
     
    class
     
    CommandLineRunnerConfig
     
    {
    
        
    @Bean
      
    
        
    public
     
    CommandLineRunner
     runner
    (){
      
    
          
    return
     
    new
     
    CommandLineRunner
    ()
     
    {
      
    
            
    public
     
    void
     run
    (
    String
    ...
     args
    ){
      
    
                log
    .
    info
    (
    "CommandLineRunner运行2"
    );
    
            
    }
      
    
          
    };
      
    
        
    }
      
    
    }

     

若多个时,可设置 @Order来确定执行的顺序。

动态修改日志级别

通过 org.springframework.boot.logging.LoggingSystem提供的api即可。

  1. loggingSystem.setLogLevel(null, LogLevel.DEBUG);

如,默认时是 info模式,未修改时, debug模式是不会输出的。

SpringBoot:使用小技巧合集_自定义_08

动态设置后

SpringBoot:使用小技巧合集_自定义_09

热部署

前面讲了这么多章节,因为功能都很单一,所以一般上都是直接重启服务来进行更新操作。但当服务功能一多,启动速度缓慢时,还是配置个热部署比较方便。在 SpringBoot中,只需要加入一个 spring-boot-devtools即可

  1.  
  2. <dependencies>
    
        
    <dependency>
    
            
    <groupId>
    org.springframework.boot
    </groupId>
    
            
    <artifactId>
    spring-boot-devtools
    </artifactId>
    
            
    <optional>
    true
    </optional>
    
        
    </dependency>
    
    </dependencies>

     

题外话:这里的 <optional>true</optional>是表示依赖不会传递,依赖了此项目的需要额外引入此包,若需要使用的话。


若不生效,可试着在打包工具 spring-boot-maven-plugin下的 configuration加入 <fork>true</fork>看看,具体配置项如下:

  1.      

         
    <plugin>
    
                    
    <groupId>
    org.springframework.boot
    </groupId>
    
                    
    <artifactId>
    spring-boot-maven-plugin
    </artifactId>
    
                    
    <configuration>
    
                      
    <fork>
    true
    </fork>
    
                    
    </configuration>
    
                
    </plugin>

     


自定义启动Banner

看烦了自带的 Banner,动手修改一个属于自己的 Banner,提现逼格的时候到了~哈哈,以下是官网给的配置指南:

SpringBoot:使用小技巧合集_spring_10

文字形式

其实,替换很简单,只需要在 classpath路径下创建一个 banner.txt即可。具体的一些变量官网也有给出,具体如下:

SpringBoot:使用小技巧合集_tomcat_11

现在我们就定制一个自己的 Banner

  1.  _              _   _                       _  __                          _

  2.  |
     
    |
                
    |
     
    |
     
    |
     
    |
                         
    |
     
    |
    / /
                             
    |
     
    |
    
     
    |
     
    |
    __     ___  
    |
     
    |
     
    |
     
    |
       ___         ___   
    |
     
    ' /    ___    _ __     __ _  | |
    
     | '
    _ \   
    /
     _ \ 
    |
     
    |
     
    |
     
    |
      
    / _ \       /
     _ \  
    |
      
    <
        
    / _ \  | '_ \   /
     _
    ` | | |
    
     | | | | |  __/ | | | | | (_) |  _  | (_) | | . \  | (_) | | | | | | (_| | |_|
    
     |_| |_|  \___| |_| |_|  \___/  ( )  \___/  |_|\_\  \___/  |_| |_|  \__, | (_)
    
                                    |/                                   __/ |    
    
                                                                        |___/     
    
    ${AnsiColor.BRIGHT_RED}
    
    Spring Boot Version: ${spring-boot.version}${spring-boot.formatted-version}       


SpringBoot:使用小技巧合集_spring_12

题外话:手输字符画是不太现实的,大家可通过一些网站进行快速生成。可自行搜索下,网上一搜一大把。

图片形式

若觉得使用文字不够酷炫,当然也可以将图片设置为启动的 banner。目前支持的图片格式有 gifpngjpg。使用也很简单,只需要命名为 banner即可。

如将头像放入目录中,最后的效果如下:

SpringBoot:使用小技巧合集_tomcat_13

当然,若图片是有色彩的,也是可以的,对于太复杂的图片显示效果就不佳了,如下。

原图:

SpringBoot:使用小技巧合集_自定义_14

banner效果图:

SpringBoot:使用小技巧合集_mvc_15

是不是很酷炫~

相关资料

1、https://docs.spring.io/spring-boot/docs/1.5.15.RELEASE/reference/htmlsingle

总结

本章节主要是简单的介绍了一些 SpringBoot的一些小技巧,一般上也就一句话或者一个注释、一句配置就解决问题的。写这篇文章时,又去翻了翻官网的指南,很不错,每次都去看都有新发现。以上有部分就是看了写下的。确实,在看官网时,一般上是需要了解哪些知识点,就搜索直奔主题了,还没有哪次是从头看的。有时间还是耐心的看一看,就是全是英文看的有点头疼,好在代码是看的懂的,⊙﹏⊙‖∣

一点吐槽

原本是想偷懒,发一点时间完成的。最后本着有图有真相且负责的原则,为了截图展现效果,实际操作了一遍,发现时间没有和写一篇正文来的少,好尴尬。。既然说了,就简单说下,接下来的章节会涉及的知识点吧。接下来还是 web开发相关,会介绍下 websocket相关知识点,这部分本人也不是很熟悉,估计写的也是简单入门的,也希望会来个聊天室的实践,加深下影响。说了 webSocket,那就不能把 Servlet3.0提供的 异步请求机制遗漏了,会介绍下原生的方式及 Spring提供的方式实现,对一些异常处理,比如超时等设置也会进行说明下,既然都说的 异步请求了,顺道也就讲下 异步调用的相关知识点吧。至于 Docker系列,鉴于本人也是初学者,写起来还是比较慢的,有时间就更吧~

最后

目前互联网上很多大佬都有 SpringBoot系列教程,如有雷同,请多多包涵了。本文是作者在电脑前一字一句敲的,每一步都是实践的。若文中有所错误之处,还望提出,谢谢。

完整实例:https://github.com/xie19900123/spring-boot-learning/tree/master/chapter