- 最佳實踐的專案結構、配置檔案、精簡的POM

注：使用程式碼生成器生成程式碼後會建立model、dao、service、web等包。


- 統一響應結果封裝及生成工具

/**
 * 統一API響應結果封裝
 */
public class Result {
    private int code;
    private String message;
    private Object data;
    public Result setCode(ResultCode resultCode) {
        this.code = resultCode.code;
        return this;
      }
   //省略getter、setter方法
}
 

/**
 * 響應碼列舉，參考HTTP狀態碼的語義
 */
public enum ResultCode {
    SUCCESS(200),//成功
    FAIL(400),//失敗
    UNAUTHORIZED(401),//未認證（簽名錯誤）
    NOT_FOUND(404),//介面不存在
    INTERNAL_SERVER_ERROR(500);//伺服器內部錯誤

    public int code;

    ResultCode(int code) {
        this.code = code;
    }
}

/**
 * 響應結果生成工具
 */
public class ResultGenerator {
    private static final String DEFAULT_SUCCESS_MESSAGE = "SUCCESS";

    public static Result genSuccessResult() {
        return new Result()
                .setCode(ResultCode.SUCCESS)
                .setMessage(DEFAULT_SUCCESS_MESSAGE);
    }

    public static Result genSuccessResult(Object data) {
        return new Result()
                .setCode(ResultCode.SUCCESS)
                .setMessage(DEFAULT_SUCCESS_MESSAGE)
                .setData(data);
    }

    public static Result genFailResult(String message) {
        return new Result()
                .setCode(ResultCode.FAIL)
                .setMessage(message);
    }
}
 

 public void configureHandlerExceptionResolvers(List<HandlerExceptionResolver> exceptionResolvers) {
        exceptionResolvers.add(new HandlerExceptionResolver() {
            public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception e) {
                Result result = new Result();
                if (e instanceof ServiceException) {//業務失敗的異常，如“賬號或密碼錯誤”
                    result.setCode(ResultCode.FAIL).setMessage(e.getMessage());
                    logger.info(e.getMessage());
                } else if (e instanceof NoHandlerFoundException) {
                    result.setCode(ResultCode.NOT_FOUND).setMessage("介面 [" + request.getRequestURI() + "] 不存在");
                } else if (e instanceof ServletException) {
                    result.setCode(ResultCode.FAIL).setMessage(e.getMessage());
                } else {
                    result.setCode(ResultCode.INTERNAL_SERVER_ERROR).setMessage("介面 [" + request.getRequestURI() + "] 內部錯誤，請聯絡管理員");
                    String message;
                    if (handler instanceof HandlerMethod) {
                        HandlerMethod handlerMethod = (HandlerMethod) handler;
                        message = String.format("介面 [%s] 出現異常，方法：%s.%s，異常摘要：%s",
                                request.getRequestURI(),
                                handlerMethod.getBean().getClass().getName(),
                                handlerMethod.getMethod().getName(),
                                e.getMessage());
                    } else {
                        message = e.getMessage();
                    }
                    logger.error(message, e);
                }
                responseResult(response, result);
                return new ModelAndView();
            }

        });
    }

public interface Service<T> {
    void save(T model);//持久化
    void save(List<T> models);//批量持久化
    void deleteById(Integer id);//通過主鍵刪除
    void deleteByIds(String ids);//批量刪除 eg：ids -> “1,2,3,4”
    void update(T model);//更新
    T findById(Integer id);//通過ID查詢
    T findBy(String fieldName, Object value) throws TooManyResultsException; //通過Model中某個成員變數名稱（非資料表中column的名稱）查詢,value需符合unique約束
    List<T> findByIds(String ids);//通過多個ID查詢//eg：ids -> “1,2,3,4”
    List<T> findByCondition(Condition condition);//根據條件查詢
    List<T> findAll();//獲取所有
}

public abstract class CodeGenerator {
   ...
    public static void main(String[] args) {
        genCode("輸入表名");
    }
    public static void genCode(String... tableNames) {
        for (String tableName : tableNames) {
            //根據需求生成，不需要的注掉，模板有問題的話可以自己修改。
            genModelAndMapper(tableName);
            genService(tableName);
            genController(tableName);
        }
    }
  ...
}

public void addInterceptors(InterceptorRegistry registry) {
    //介面簽名認證攔截器，該簽名認證比較簡單，實際專案中可以使用Json Web Token或其他更好的方式替代。
    if (!"dev".equals(env)) { //開發環境忽略簽名認證
        registry.addInterceptor(new HandlerInterceptorAdapter() {
            @Override
            public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
                //驗證簽名
                boolean pass = validateSign(request);
                if (pass) {
                    return true;
                } else {
                    logger.warn("簽名認證失敗，請求介面：{}，請求IP：{}，請求引數：{}",
                            request.getRequestURI(), getIpAddress(request), JSON.toJSONString(request.getParameterMap()));

                    Result result = new Result();
                    result.setCode(ResultCode.UNAUTHORIZED).setMessage("簽名認證失敗");
                    responseResult(response, result);
                    return false;
                }
            }
        });
    }
}

/**
 * 一個簡單的簽名認證，規則：
 * 1. 將請求引數按ascii碼排序
 * 2. 拼接為a=value&b=value...這樣的字串（不包含sign）
 * 3. 混合金鑰（secret）進行md5獲得簽名，與請求的簽名進行比較
 */
private boolean validateSign(HttpServletRequest request) {
        String requestSign = request.getParameter("sign");//獲得請求籤名，如sign=19e907700db7ad91318424a97c54ed57
        if (StringUtils.isEmpty(requestSign)) {
            return false;
        }
        List<String> keys = new ArrayList<String>(request.getParameterMap().keySet());
        keys.remove("sign");//排除sign引數
        Collections.sort(keys);//排序

        StringBuilder sb = new StringBuilder();
        for (String key : keys) {
            sb.append(key).append("=").append(request.getParameter(key)).append("&");//拼接字串
        }
        String linkString = sb.toString();
        linkString = StringUtils.substring(linkString, 0, linkString.length() - 1);//去除最後一個'&'

        String secret = "Potato";//金鑰，自己修改
        String sign = DigestUtils.md5Hex(linkString + secret);//混合金鑰md5

        return StringUtils.equals(sign, requestSign);//比較
}