spring boot 使用筆記

一、配置視圖解析

在resources文件夾下新建static文件夾（用來儲存靜態資源）

配置application.yml

spring:
	  mvc:
		view:
  			prefix: /
  			suffix: .html

將html頁面存放在static文件夾下

Spring Boot：攔截器與過濾器

一、攔截器與過濾器
在講Spring boot之前，我們先了解一下過濾器和攔截器。這兩者在功能方面很類似，但是在具體技術實現方面，差距還是比較大的。在分析兩者的區別之前，我們先理解一下AOP的概念，AOP不是一種具體的技術，而是一種編程思想。在面向對象編程的過程中，我們很容易通過繼承、多態來解決縱向擴展。但是對於橫向的功能，比如，在所有的service方法中開啓事務，或者統一記錄日誌等功能，面向對象的是無法解決的。所以AOP——面向切面編程其實是面向對象編程思想的一個補充。而我們今天講的過濾器和攔截器都屬於面向切面編程的具體實現。而兩者的主要區別包括以下幾個方面：

1.Filter的執行由Servlet容器回調完成，而攔截器通常通過動態代理的方式來執行。
2. Filter的執行由Servlet容器回調完成，而攔截器通常通過動態代理的方式來執行。
3. Filter的生命週期由Servlet容器管理，而攔截器則可以通過IoC容器來管理，因此可以通過注入等方式來獲取其他Bean的實例，因此使用會更方便。

二、過濾器的配置
現在我們通過過濾器來實現記錄請求執行時間的功能，其實現如下：

public class LogCostFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
    }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        long start = System.currentTimeMillis();
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Execute cost="+(System.currentTimeMillis()-start));
    }
 
    @Override
    public void destroy() {
 
    }
}

這段代碼的邏輯比較簡單，就是在方法執行前先記錄時間戳，然後通過過濾器鏈完成請求的執行，在返回結果之間計算執行的時間。這裏需要主要，這個類必須繼承Filter類，這個是Servlet的規範，這個跟以前的Web項目沒區別。但是，有了過濾器類以後，以前的web項目可以在web.xml中進行配置，但是spring boot項目並沒有web.xml這個文件，那怎麼配置？在Spring boot中，我們需要FilterRegistrationBean來完成配置。其實現過程如下：

@Configuration
public class FilterConfig {
 
    @Bean
    public FilterRegistrationBean registFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new LogCostFilter());
        registration.addUrlPatterns("/*");
        registration.setName("LogCostFilter");
        registration.setOrder(1);
        return registration;
    }
 
}

這樣配置就完成了，需要配置的選項主要包括實例化Filter類，然後指定url的匹配模式，設置過濾器名稱和執行順序，這個過程和在web.xml中配置其實沒什麼區別，只是形式不同而已。現在我們可以啓動服務器訪問任意URL：
　
　大家可以看到上面的配置已經生效了。除了通過 FilterRegistrationBean 來配置以外，還有一種更直接的辦法，直接通過註解就可以完成了：

@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
public class LogCostFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
 
    }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        long start = System.currentTimeMillis();
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
    }
 
    @Override
    public void destroy() {
 
    }
}

這裏直接用@WebFilter就可以進行配置，同樣，可以設置url匹配模式，過濾器名稱等。這裏需要注意一點的是@WebFilter這個註解是Servlet3.0的規範，並不是Spring boot提供的。除了這個註解以外，我們還需在配置類中加另外一個註解：@ServletComponetScan，指定掃描的包。

@SpringBootApplication
@MapperScan("com.pandy.blog.dao")
@ServletComponentScan("com.pandy.blog.filters")
public class Application {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

現在，我們再來訪問一下任意URL：
　
　可以看到，我們配置的兩個過濾器都生效了。細心的讀者會發現，第二個Filter我們並沒有指定執行的順序，但是卻在第一個Filter之前執行。這裏需要解釋一下，@WebFilter這個註解並沒有指定執行順序的屬性，其執行順序依賴於Filter的名稱，是根據Filter類名（注意不是配置的filter的名字）的字母順序倒序排列，並且@WebFilter指定的過濾器優先級都高於FilterRegistrationBean配置的過濾器。有興趣的朋友可以自己實驗一下。

三、攔截器的配置
上面我們已經介紹了過濾器的配置方法，接下來我們再來看看如何配置一個攔截器。我們使用攔截器來實現上面同樣的功能，記錄請求的執行時間。首先我們實現攔截器類：

public class LogCostInterceptor implements HandlerInterceptor {
    long start = System.currentTimeMillis();
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        start = System.currentTimeMillis();
        return true;
    }
 
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));
    }
 
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
    }
}

這裏我們需要實現HandlerInterceptor這個接口，這個接口包括三個方法，preHandle是請求執行前執行的，postHandler是請求結束執行的，但只有preHandle方法返回true的時候纔會執行，afterCompletion是視圖渲染完成後才執行，同樣需要preHandle返回true，該方法通常用於清理資源等工作。除了實現上面的接口外，我們還需對其進行配置：

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
}

這裏我們繼承了WebMVCConfigurerAdapter，看過前面的文章的朋友應該已經見過這個類了，在進行靜態資源目錄配置的時候我們用到過這個類。這裏我們重寫了addInterceptors這個方法，進行攔截器的配置，主要配置項就兩個，一個是指定攔截器，第二個是指定攔截的URL。現在我們再啓動系統訪問任意一個URL：

可以看到，我們通過攔截器實現了同樣的功能。不過這裏還要說明一點的是，其實這個實現是有問題的，因爲preHandle和postHandle是兩個方法，所以我們這裏不得不設置一個共享變量start來存儲開始值，但是這樣就會存在線程安全問題。當然，我們可以通過其他方法來解決，比如通過ThreadLocal就可以很好的解決這個問題，有興趣的同學可以自己實現。不過通過這一點我們其實可以看到，雖然攔截器在很多場景下優於過濾器，但是在這種場景下，過濾器比攔截器實現起來更簡單。

四、總結
攔截器這一段主要對基於Spring boot對過濾器和攔截器的配置進行的講解。無論是過濾器還是攔截器都屬於AOP（面向切面編程）思想的具體實現。除了這兩種實現我們還見過另一種更靈活的AOP實現技術，即Aspect，我們可以通過Aspect來完成更多更強大的功能。這個後續再給大家分享。

實例類註解

時間註解

@DateTimeFormat(pattern = "時間格式")

yml文件配置
spring: 
	jackson:
    	date-format: yyyy-MM-dd
    	joda-date-time-format: yyyy-MM-dd HH:mm:ss

SpringBoot 參數校驗的方法

@AssertFalse 所註解的元素必須是Boolean類型，且值爲false
@AssertTrue 所註解的元素必須是Boolean類型，且值爲true
@DecimalMax 所註解的元素必須是數字，且值小於等於給定的值
@DecimalMin 所註解的元素必須是數字，且值大於等於給定的值
@Digits 所註解的元素必須是數字，且值必須是指定的位數
@Future 所註解的元素必須是將來某個日期
@Max 所註解的元素必須是數字，且值小於等於給定的值
@Min 所註解的元素必須是數字，且值小於等於給定的值
@Range 所註解的元素需在指定範圍區間內
@NotNull 所註解的元素值不能爲null
@NotBlank 所註解的元素值有內容
@Null 所註解的元素值爲null
@Past 所註解的元素必須是某個過去的日期
@PastOrPresent 所註解的元素必須是過去某個或現在日期
@Pattern 所註解的元素必須滿足給定的正則表達式
@Size 所註解的元素必須是String、集合或數組，且長度大小需保證在給定範圍之內
@Email 所註解的元素需滿足Email格式

在controller層的參數校驗可以分爲兩種場景：

單個參數校驗
實體類參數校驗

單個參數校驗

@RestController
@Validated
public class PingController {

    @GetMapping("/getUser")
    public String getUserStr(@NotNull(message = "name 不能爲空") String name,
                             @Max(value = 99, message = "不能大於99歲") Integer age) {
        return "name: " + name + " ,age:" + age;
    }
}

當處理GET請求時或只傳入少量參數的時候，我們可能不會建一個bean來接收這些參數，就可以像上面這樣直接在controller方法的參數中進行校驗。

注意：這裏一定要在方法所在的controller類上加入@Validated註解，不然沒有任何效果。
這時候在postman輸入請求：

http://localhost:8080/getUser?name=Allan&age=101

調用方會收到springboot默認的格式報錯：

{
    "timestamp": "2019-06-01T04:30:26.882+0000",
    "status": 500,
    "error": "Internal Server Error",
    "message": "getUserStr.age: 不能大於99歲",
    "path": "/getUser"
}

javax.validation.ConstraintViolationException: getUserStr.age: 不能大於99歲
   at org.springframework.validation.beanvalidation.MethodValidationInterceptor.invoke(MethodValidationInterceptor.java:116)
   at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:185)
   at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:688)
   at io.shopee.bigdata.penalty.server.controller.PingController$$EnhancerBySpringCGLIB$$232cfd51.getUserStr(<generated>)
   ...

具體詳情參考：SpringBoot 參數校驗的方法

項目報錯統一處理（劉俊秦是本人，請忽略）

當我們開發項目，經常需要捕獲很多異常時，幾乎每個接口都需要重寫很多捕獲代碼。（本人就很煩，所有寫了一個統一處理的方法）
怎麼處理呢，我們可以掃碼包下全部的Controller 的異常。捕獲它，進行我們的異常處理。springboot 就提供了一個註解

/*
 * 功能描述: 
 * 〈統一異常處理〉
 * 
 * @param null 1
 * @return : 
 * @author : ljq-劉俊秦
 * @date : 2020/5/16 0016 下午 5:05
 */

@ControllerAdvice(
        //指定攔截包的控制器
        basePackages = {"com.*.*.controller.*"},
        //限定被標註爲@Controller或者@RestController的類才被攔截
        annotations = {Controller.class, RestController.class}
)
public class ControllerExHandler {

    //異常處理，可以定義異常類型進行攔截處理
    @ExceptionHandler(value = BaseException.class)
    @ResponseBody
    //定義爲服務器錯誤狀態碼
    @ResponseStatus(HttpStatus.OK)
    public ServiceResult baseException(BaseException e) {
        return ServiceResult.failure(e.getCode(), e.getMessage());
    }

    //ex異常處理，可以定義異常類型進行攔截處理
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    //定義爲服務器錯誤狀態碼
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ServiceResult exception(Exception e) {
        LogPrintUtil.logRunTimeError(e);
        return ServiceResult.failure(ReturnCode.FAILURE);
    }

    //io異常處理，可以定義異常類型進行攔截處理
    @ExceptionHandler(value = IOException.class)
    @ResponseBody
    //定義爲服務器錯誤狀態碼
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ServiceResult ioException(IOException e) {
        LogPrintUtil.logRunTimeError(e);
        return ServiceResult.failure(ReturnCode.JAVA_IO);
    }

}

Springboot用@PathVariable傳參，最後一個參數會丟失小數點後面的部分

當使用@PathVariable傳遞路徑參數時，竟然神奇的發現，後面一位參數的小數點後面部分竟然不見啦，如下代碼：

Controller方法註解如下：

@RequestMapping(value = "/user/findPassword/{email}", method = RequestMethod.GET, produces="application/json")

我這裏是想傳遞個郵箱過來的，然後就發現了沒有郵箱後綴。
百思不得其解，遂百度之，解決方法如下：

@RequestMapping(value = "/user/findPassword/{email:.+}", method = RequestMethod.GET, produces="application/json")

spring boot 使用筆記

一、配置視圖解析

Spring Boot：攔截器與過濾器

實例類註解

SpringBoot 參數校驗的方法

單個參數校驗

項目報錯統一處理（劉俊秦是本人，請忽略）

Springboot用@PathVariable傳參，最後一個參數會丟失小數點後面的部分

Java個人筆記

spring boot 整合 activiti 6.0

springboot aop個人使用筆記

Docker常用命令個人筆記

FastJSON 使用個人筆記

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結

spring boot 使用筆記

一、配置視圖解析

Spring Boot：攔截器與過濾器

實例類註解

SpringBoot 參數校驗的方法

單個參數校驗

項目報錯 統一處理 （劉俊秦是本人，請忽略）

Springboot用@PathVariable傳參，最後一個參數會丟失小數點後面的部分

項目報錯統一處理（劉俊秦是本人，請忽略）