地产云：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;
    }

}