Spring boot之攔截器與定時任務的實現
阿新 • • 發佈:2019-01-08
- 場景:由於用Spring boot編寫了關於Ranger策略以及Hive脫敏相關的介面,並以http方式向外部提供。
- 為了防止請求被非法模仿,因而編寫了一個訪問Ip 鑑權類,也就是設定了訪問ip白名單,只有在白名單上的ip才可以訪問介面。
- Spring boot自帶HandlerInterceptor,可通過繼承它來實現攔截功能,其的功能跟過濾器類似,但是提供更精細的的控制能力:
在request被響應之前、request被響應之後、檢視渲染之前以及request全部結束之後。我們不能通過攔截器修改request內容,但是可以通過丟擲異常(或者返回false)來暫停request的執行。
程式碼如下所示:
1、建立攔截器,並實現業務邏輯
package com.bms.utils; import java.io.OutputStream; import java.util.List; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import org.jboss.logging.Logger; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.ModelAndView; /** * @author YeChunBo * @time 2017年9月8日 * * 類說明: ip 攔截器,只有在配置檔案中定義了的ip 才可以訪問介面 */ public class URLInterceptor implements HandlerInterceptor { private static final Logger logger = Logger.getLogger(URLInterceptor.class); public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3) throws Exception { // TODO Auto-generated method stub } public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3) throws Exception { // TODO Auto-generated method stub } /** * 在請求處理之前進行呼叫(Controller方法呼叫之前)呼叫, * 返回true 則放行, false 則將直接跳出方法 */ public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object arg2) throws Exception { String ip = getIpAddr(request); String ipStr = PropertyUtil.getProperty("ipWhiteList"); // 獲取可以訪問系統的白名單 String[] ipArr = ipStr.split("\\|"); List<String> ipList = java.util.Arrays.asList(ipArr); if (ipList.contains(ip)) { logger.info("the request ip is : " + ip); return true; } else { logger.error(ip + " is not contains ipWhiteList ......."); response.setHeader("Content-type","text/html;charset=UTF-8");//向瀏覽器傳送一個響應頭,設定瀏覽器的解碼方式為UTF-8 String data = "您好,ip為" + ip + ",暫時沒有訪問許可權,請聯絡管理員開通訪問許可權。"; OutputStream stream = response.getOutputStream(); stream.write(data.getBytes("UTF-8")); return false; } } /** * 獲取訪問的ip地址 * * @param request * @return */ public static String getIpAddr(HttpServletRequest request) { String ip = request.getHeader("X-Forwarded-For"); if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("Proxy-Client-IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("WL-Proxy-Client-IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("HTTP_CLIENT_IP"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getHeader("HTTP_X_FORWARDED_FOR"); } if (ip == null || ip.length() == 0 || "unknown".equalsIgnoreCase(ip)) { ip = request.getRemoteAddr(); } return ip; } }
2、註冊攔截器
package com.bms.utils; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter; /** * @author YeChunBo * @time 2017年9月8日 * * 類說明: ip 鑑權類,只有在配置檔案中定義了的ip 才可以訪問介面 */ @Configuration public class MyWebAppConfigurer extends WebMvcConfigurerAdapter { @Bean //把我們的攔截器注入為bean public HandlerInterceptor getMyInterceptor(){ return new URLInterceptor(); } @Override public void addInterceptors(InterceptorRegistry registry) { // addPathPatterns 用於新增攔截規則, 這裡假設攔截 /url 後面的全部連結 // excludePathPatterns 使用者排除攔截 registry.addInterceptor(getMyInterceptor()).addPathPatterns("/**"); super.addInterceptors(registry); } }
訪問結果如下所示:
二、定時任務
package com.bms.qurat;
/**
* @author YeChunBo
* @time 2017年10月10日
*
* 類說明 :定時任務的設定類
*/
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import com.bms.service.HdfsService;
import com.bms.service.HiveTableInfoService;
import com.bms.service.SyncGzdcTableInfo2DbService;
import com.bms.service.SyncUserVisitInfo2Db;
@Component
public class QuartzJob {
private static final Logger logger = LoggerFactory.getLogger(Scheduled.class);
// 每十五分鐘執行一次,監控使用者對於磁碟使用情況
@Scheduled(cron = "0 0/15 * * * ?")
public void executeMonitorTask() {
logger.info("Scheduled.compareAllUserDiskTask is begin ....");
// 超過磁碟設定的值後,定時任務獲取對應策略,若存在create許可權則修改,不存在則不改
boolean compareAllUserDisk = HdfsService.compareAllUserDisk();
logger.info("Scheduled.compareAllUserDiskTask and the result:" + compareAllUserDisk);
}
}
其實就是在方法之上引入如下註解:
@Scheduled(cron = "0 0/15 * * * ?")
定時任務引數說明:
* 第一位,表示秒,取值0-59
* 第二位,表示分,取值0-59
* 第三位,表示小時,取值0-23
* 第四位,日期天/日,取值1-31
* 第五位,日期月份,取值1-12
* 第六位,星期,取值1-7,星期一,星期二...,注:不是第1周,第二週的意思
另外:1表示星期天,2表示星期一。
* 第7為,年份,可以留空,取值1970-2099
cron中,還有一些特殊的符號,含義如下:
(*)星號:可以理解為每的意思,每秒,每分,每天,每月,每年...
(?)問號:問號只能出現在日期和星期這兩個位置,表示這個位置的值不確定,每天3點執行,所以第六位星期的位置,我們是不需要關注的,就是不確定的值。同時:日期和星期是兩個相互排斥的元素,通過問號來表明不指定值。比如,1月10日,比如是星期1,如果在星期的位置是另指定星期二,就前後衝突矛盾了。
(-)減號:表達一個範圍,如在小時欄位中使用“10-12”,則表示從10到12點,即10,11,12
(,)逗號:表達一個列表值,如在星期欄位中使用“1,2,4”,則表示星期一,星期二,星期四
(/)斜槓:如:x/y,x是開始值,y是步長,比如在第一位(秒) 0/15就是,從0秒開始,每15秒,最後就是0,15,30,45,60 另:*/y,等同於0/y
下面列舉幾個例子供大家來驗證:
0 0 3 * * ? 每天3點執行
0 5 3 * * ? 每天3點5分執行
0 5 3 ? * * 每天3點5分執行,與上面作用相同
0 5/10 3 * * ? 每天3點的 5分,15分,25分,35分,45分,55分這幾個時間點執行
0 10 3 ? * 1 每週星期天,3點10分 執行,注:1表示星期天
0 10 3 ? * 1#3 每個月的第三個星期,星期天 執行,#號只能出現在星期的位置