地產雲：java異常和 controller的json返回對象HttpResult

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

/**
 * 最基礎的異常類。
 * @author zhangxin13
 * @version 2017年11月2日下午7:20:46
 * @since 2017年11月2日
 */
abstract class AbstractException extends RuntimeException implements ExceptionInfo {
    private static final long serialVersionUID = 3289598099629324399L;
    private int code;
    private String message;
    private Object body;
    public AbstractException(ExceptionInfo info){
        this.code = info.getCode();
        this.message = info.getMessage();
        this.body = null;
    }
    public AbstractException(ExceptionInfo info, Object body){
        this.code = info.getCode();
        this.message = info.getMessage();
        this.body = body;
    }
    @Override
    public String getMessage() {
        return message;
    }
    @Override
    public int getCode() {
        return code;
    }
    public Object getBody() {
        return body;
    }
}

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

/**
 * 業務異常。比如輸入錯誤的數據導致業務失敗，邏輯進入到非主線分支，需要拒絕服務，讓客戶端提交正確的參數即可恢復。
 * 因此當遇到這種異常的時候，其實業務邏輯是執行成功的，只不過進入了非主線分支而已<br>
 * 當發生BusinessException時，客戶端返回的http code總是200
 * @author zhangxin13
 * @version 2017年11月7日上午9:40:35
 * @since 2017年11月7日
 */
public abstract class BusinessException extends AbstractException {
    private static final long serialVersionUID = -4853537210488828688L;
    public BusinessException(ExceptionInfo info) {
        super(info);
    }
    public BusinessException(ExceptionInfo info, Object body) {
        super(info, body);
    }
}

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

/**
 * 調用方異常。這類錯誤一般是servlet容器處理的，這里作為預留<br>
 * 當發生ClientException時，客戶端返回的http code默認400
 * @author zhangxin13
 * @version 2017年11月2日下午7:19:12
 * @since 2017年11月2日
 */
public abstract class ClientException extends AbstractException {
    private static final long serialVersionUID = 5214893309908224949L;
    public ClientException(ExceptionInfo info) {
        super(info);
    }
    public ClientException(ExceptionInfo info, Object body) {
        super(info, body);
    }
}

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

/**
 * 由服務器上的邏輯漏洞或者其他什么原因導致的無法由客戶端重新提交來糾正的錯誤，
 * 比如服務器代碼上寫的不嚴謹在某個地方報了空指針異常，這種問題客戶端無論提交多少次正確的參數都無法修正，
 * 因此是屬於服務器內部錯誤。<br>
 * 當發生ServerException時，向客戶端返回的http code為5xx。
 * @author zhangxin13
 * @version 2017年11月2日下午7:19:20
 * @since 2017年11月2日
 */
public abstract class ServerException extends AbstractException {
    private static final long serialVersionUID = 3117351252348483331L;
    public ServerException(ExceptionInfo info) {
        super(info);
    }
    public ServerException(ExceptionInfo info, Object body) {
        super(info, body);
    }
}

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

/**
 * 
 * @author zhangxin13
 * @version 2017年11月6日下午9:02:52
 * @since 2017年11月6日
 */
public interface ExceptionInfo {
    public int getCode();
    public String getMessage();
}

/**
 * 
 */
package com.hikvision.building.cloud.gaia.common.exception;

import java.util.Arrays;
import java.util.Map;
import java.util.Map.Entry;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.util.CollectionUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import com.hikvision.building.cloud.gaia.common.structs.HttpResult;

/**
 * 全局異常處理
 * @author zhangxin13
 * @version 2017年11月6日下午9:25:06
 * @since 2017年11月6日
 */
@ControllerAdvice
public class ExceptionHandlerAdvice {
    private Logger logger = LoggerFactory.getLogger(getClass());

    @ExceptionHandler(BusinessException.class)
    @ResponseBody
    public HttpResult<String> handlerServerException(HttpServletRequest request, HttpServletResponse response,
            BusinessException e){
        response.setStatus(200);//總是返回200
        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Cache-Control", "no-cache");
        logger.info("業務異常: code: {}, message: {}", e.getCode(), e.getMessage());
        logger.info("URI: {}, Method: {}, Parameter: {}, DebugMessage: {}",
                request.getRequestURI(), request.getMethod(), parameterMap2String(request.getParameterMap()),
                e.getBody());
        return build(e.getCode(), e.getMessage());
    }
    @ExceptionHandler(ServerException.class)
    @ResponseBody
    public HttpResult<String> handlerServerException(HttpServletRequest request, HttpServletResponse response, 
            ServerException e) {
        if(e.getCode()<=500 || e.getCode()>599){//沒有設定 RFC 2616 規范所定義的錯誤碼，則強制設定500
            response.setStatus(500);
            logger.warn("URI: {}, Method: {} 中返回了一個不嚴謹的錯誤碼：{}",
                    request.getRequestURI(), request.getMethod(), e.getCode());
        }else{
            response.setStatus(e.getCode());
        }
        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Cache-Control", "no-cache");
        logger.warn("服務端異常", e);
        logger.warn("URI: {}, Method: {}, Parameter: {}, DebugMessage: {}",
                request.getRequestURI(), request.getMethod(), parameterMap2String(request.getParameterMap()),
                e.getBody());
        return build(e.getCode(), e.getMessage());
    }
    
    @ExceptionHandler(ClientException.class)
    @ResponseBody
    public HttpResult<String> handlerClientException(HttpServletRequest request, HttpServletResponse response, 
            ClientException e) {
        if(e.getCode()<=400 || e.getCode()>499){//沒有設定 RFC 2616 規范所定義的錯誤碼，則強制設定400
            response.setStatus(400);
            logger.warn("URI: {}, Method: {} 中返回了一個不嚴謹的錯誤碼：{}",
                    request.getRequestURI(), request.getMethod(), e.getCode());
        }else{
            response.setStatus(e.getCode());
        }
        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Cache-Control", "no-cache");
        logger.warn("客戶端異常", e);
        logger.warn("URI: {}, Method: {}, Parameter: {}, DebugMessage: {}",
                request.getRequestURI(), request.getMethod(), parameterMap2String(request.getParameterMap()),
                e.getBody());
        return build(e.getCode(), e.getMessage());
    }
    
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public HttpResult<String> handlerException(HttpServletRequest request, HttpServletResponse response, 
            Exception e) {
        response.setStatus(500);//所有未捕獲的的異常
        response.setContentType("application/json");
        response.setCharacterEncoding("UTF-8");
        response.setHeader("Cache-Control", "no-cache");
        logger.error("發生未捕獲異常! URI: {}, Method: {}, RemoteHost: {}",
                request.getRequestURI(), request.getMethod(), request.getRemoteHost());
        logger.error("未捕獲異常", e);
        return build(500, e.getMessage());
    }
    
    private String parameterMap2String(Map<String, String[]> map){
        if(CollectionUtils.isEmpty(map)){
            return "{}";
        }
        StringBuilder sb = new StringBuilder("{");
        for(Entry<String, String[]> entry: map.entrySet()){
            sb.append(entry.getKey())
                .append('=')
                .append(Arrays.toString(entry.getValue()))
                .append(',');
        }
        sb.deleteCharAt(sb.length()-1).append('}');
        return sb.toString();
    }
    
    private HttpResult<String> build(int code,String message){
        HttpResult<String> r = new HttpResult<>();
        r.setCode(code);
        r.setMessage(message);
        return r;
    }
    
}

package com.hikvision.building.cloud.gaia.common.structs;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel
public class HttpResult<T> {
    public static final int OK = 0;
    @ApiModelProperty(value="消息碼",required=true,example="0")
    private Integer code = 0;
    @ApiModelProperty(value="提示信息。主要用於開發調試，不建議顯示給用戶",required=true)
    private String message;
    @ApiModelProperty(value="返回包體",required=true)
    private T data;
    @ApiModelProperty(value="是否正常返回",required=true,example="true",notes="主要預留給某些不方便判斷code的場景，只要code不是0，這個字段就是false")
    private boolean success = true;
    
    public HttpResult() {}
    public HttpResult(T data) {
        this.data = data;
    }
    
    public Integer getCode() {
        return code;
    }
    
    public void setCode(Integer code) {
        this.code = code;
        if (code != OK) {
            this.success = false;
        }
    }
    
    public String getMessage() {
        return message;
    }
    
    public void setMessage(String message) {
        this.message = message;
    }
    
    public T getData() {
        return data;
    }
    
    public void setData(T data) {
        this.data = data;
    }
    
    public boolean isSuccess() {
        return this.success;
    }

    @Override
    public String toString() {
        return "HttpResult [code=" + code + ", message=" + message + ", data=" + data + ", success=" + success + "]";
    }
    
}

package com.hikvision.building.cloud.neptune.community.biz.exception;

import com.hikvision.building.cloud.gaia.common.exception.BusinessException;
import com.hikvision.building.cloud.neptune.community.biz.constant.CommunityExceptionEnum;

public abstract class CommunityBusinessException extends BusinessException{
    private static final long serialVersionUID = 1979830642167998428L;

    public CommunityBusinessException(CommunityExceptionEnum info,Object object) {
        super(info,object);
    }
    
    public CommunityBusinessException(CommunityExceptionEnum info) {
        super(info);
    }

}

package com.hikvision.building.cloud.neptune.community.biz.exception;

import com.hikvision.building.cloud.neptune.community.biz.constant.CommunityExceptionEnum;

public class AreaNotExistException extends CommunityBusinessException{
    
    private static final long serialVersionUID = 6751736070431967875L;

    public AreaNotExistException(Object object) {
        super(CommunityExceptionEnum.AREA_NOT_EXIST,object);
    }

}

package com.hikvision.building.cloud.neptune.device.biz.constant;

import com.hikvision.building.cloud.gaia.common.exception.ExceptionInfo;

/** 
 * @Description 異常碼枚舉類
 * @author like15
 * @version v1.0
 * @date 2017年11月16日 下午1:35:02
 * @modificationHistory=========================邏輯或功能性重大變更記錄
 * @modify by user: like15 2017年11月16日
 * @since 2017年11月16日
 */
public enum DeviceExceptionEnum implements ExceptionInfo{
    
    /**pageNo或者pageSize信息為空。*/
    DEVICE_PAGE_PARAM_EXCEPTION(960001,"pageNo或者pageSize信息不合法，必須為正整數。"),
    
    /**該社區下未配置網關信息。*/
    DEVICE_USERID_TOKEN_NULL(960002,"userId或者token信息為空。"),
    
    /**該社區下未配置網關信息。*/
    DEVICE_QUERY_TENANTID_NULL(960003,"查詢租戶id失敗。"),
    
    /**該社區下未配置網關信息。*/
    GATEWAY_NOT_LINK(960004,"設備網關不存在或未連接"),
    
    /**該社區下未配置網關信息。*/
    DEVICE_UNIT_ALREADY_EXIST(960005,"添加設備失敗，該單元已存在其他門口機設備。"),
    
    /**設備添加參數異常,devAddId、valiCode、ip、port、userName或者password為空。*/
    BAD_PARAMETER_DEVICE_ADD(960101,"設備添加參數異常,devAddId、ip、port、userName或者password為空。"),
    
    /**該社區下未配置網關信息。*/
    DEVICE_GATEWAY_NOT_EXIST(960102,"該社區下未配置網關信息。"),
    
    /**設備信息不存在或已刪除。*/
    DEVICE_NOT_EXIST(960103,"設備信息不存在或已刪除。"),
    
    /**設備位置信息path查詢異常。*/
    DEVICE_ADDRESS_PATH_EXCEPTION(960104,"設備位置信息path查詢異常。"),
    
    /**設備位置信息pathMap查詢異常。*/
    DEVICE_ADDRESS_PATH_MAP_EXCEPTION(960105,"設備位置信息pathMap查詢異常。"),
    
    /**該設備已被添加。*/
    DEVICE_ALREADY_EXIST_EXCEPTION(960106,"該設備已被添加。"),
    
    /**調用螢石協議刪除設備失敗。*/
    DEVICE_EZVIZ_DELETE_FAIL(960107,"調用螢石協議刪除設備失敗。"),
    
    /**設備IP或者端口不正確。*/
    DEVICE_IP_POER_ILLEGAL(960108,"設備IP或者端口不正確。"),
    
    /**設備用戶名或密碼不正確。*/
    DEVICE_USERNAME_PASSWORD_ILLEGAL(960109,"設備用戶名或密碼不正確。"),
    
    /**設備用戶名或密碼不正確。*/
    DEVICE_VALICODE_ILLEGAL(960110,"設備驗證碼不正確。"),
    
    /**設備位置信息path查詢異常。*/
    DEVICE_ADDRESS_PATH_NUMBER_EXCEPTION(960111,"設備位置信息path編號查詢異常。"),
    
    /**通行權限路徑下沒有設備信息。*/
    PATH_DEVICE_NOT_EXIST(960112,"通行權限路徑下沒有設備信息。"),
    
    /**卡號不能為空。*/
    CARD_BUMBER_NOT_EXIST(960113,"獲取卡號信息異常。"),
    
    /**調用螢石協議刪除設備失敗。*/
    DEVICE_DELETE_FAIL(960114,"刪除失敗。"),
    
    /**communityId為空。*/
    BAD_PARAMETER_DEVICE_COMMUNITYID_NULL(960201,"communityId為空。"),
    
    /**devId為空。*/
    BAD_PARAMETER_DEVICE_DEVSERIAL_NULL(960202,"devId為空。"),
    
    /**communityId或者tenantId為空。*/
    BAD_PARAMETER_DEVICE_COMMUNITYID_TENANTID_NULL(960203,"communityId或者tenantId為空。"),
    
    /**callId、callDuration或者eventTime為空。*/
    BAD_PARAMETER_CALL_NULL(960301,"callId、callDuration、devSerial或者eventTime為空。"),
    
    /**callId對應的呼叫記錄不存在為空。*/
    CALL_LOG_NOT_EXIST_EXCEPTION(960302,"callId對應的呼叫記錄不存在為空。"),
    ;

    private int code;
    private String message;
    private DeviceExceptionEnum(int code, String message) {
        this.code = code;
        this.message = message;
    }
    @Override
    public int getCode() {
        return code;
    }

    @Override
    public String getMessage() {
        return message;
    }

}