在後臺介面開發中會有一類介面是需要做登入校驗的,類似於生成訂單,檢視自己的訂單列表等介面,都需要先判斷使用者是否登入.雖然可以在介面中進行判斷,但是會讓程式碼冗餘,所以決定用自定義攔截器+自定義註解來完成這個功能

自定義攔截器可以實現HandlerInterceptor介面或者繼承HandlerInterceptorAdapter類,HandlerInterceptorAdapter介面卡是對HandlerInterceptor介面做了預設實現, 這種介面卡模式, 是為了方便開發者只去想要複寫方法, 其他方法採取預設措施.

public class AuthenticationInterceptor extends HandlerInterceptorAdapter {
	private Logger log = LoggerFactory.getLogger(this.getClass());
	@Autowired
	TokenTools tokenTools;
	
	//在執行目標方法之前執行
	@Override
	public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
		throws Exception {
		if (handler.getClass().isAssignableFrom(HandlerMethod.class)) {
			Authentication Authentication = ((HandlerMethod) handler)
					.getMethodAnnotation(Authentication.class);
			//如果沒用Authentication這個註解標註的介面或者validate=false則直接通過
			if (Authentication == null
					|| Authentication.validate() == false) {
				return true;
			} else {
				String userToken = request.getParameter("token");
				log.debug("current token**************: " + userToken);
				if (StringUtils.isBlank(userToken)) {
					returnValue(response);
					return false;
				} else {
					if (!tokenTools.checkLoginInfo(userToken)) {
						returnValue(response);
						return false;
					}
					log.debug("You have logged in successfully!");
					return true;
				}
			}
		}else {
			return true;
		}
	}
	
	private void returnValue(HttpServletResponse response)
			throws IOException {
		Map<String, Object> resultMap = new HashMap<String, Object>();
		resultMap.put("resultcode", "0003");
		resultMap.put("message", "登陸失效");
		response.setCharacterEncoding("UTF-8");
		response.setContentType("application/json; charset=utf-8");
		response.getWriter().write(JSON.toJSONString(resultMap));
	}
}

自定義註解

/**
 * 需要登入的介面需要使用該註解
 * @author cihon
 *
 */
@Target(ElementType.METHOD) //指示註釋型別所適用的程式元素的種類。
@Retention(RetentionPolicy.RUNTIME) //指示註釋型別的註釋要保留多久。
public @interface Authentication {
	boolean validate() default true;
}

我們需要定義一個配置檔案的類來讓自定義攔截器生效

/**
 * 自定義攔截器配置檔案
 * @author cuizheng
 *
 */
@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {
	
	@Override
	public void addInterceptors(InterceptorRegistry registry) {
		registry.addInterceptor(new AuthenticationInterceptor()
 
).addPathPatterns("/**");
	}
}

像下面這個介面加上@Authentication這個註解後就會做登入校驗的判斷

        @Authentication
	@RequestMapping({"/saveImage"})
	public String saveImage(@RequestHeader("header") String header,  String userName) {
		String s = new String(Base64.decode(body));
	
		return leBorrowService.saveImage(header,s);
	}
 

在這裡有可能會遇到Required request body is missing這個異常，是因為在攔截器中Request的引數一次性消費，並且不能回寫，解決辦法

如上圖，採用這種上傳方法，在攔截器中取出token後userName還能傳到介面中