Solon

十四、统一的渲染控制

下面这个场景是特意为此文设计出来的,有点儿乱。但凡类似的场景。。。Solon 都可以给你一个so easy的支持。

Solon 特性之一:

可让控制器实现 Render,从而接管控制器的渲染动作。

1、定义个接口基类,并实现渲染接口

渲染逻辑如下:

  1. 如果对象是null,跳过不管
  2. 如果是String,直接输出
  3. 如果是ModelAndView,直接渲染
  4. 如果是UapiCode,将其转为Result,再交给框架渲染
  5. 如果是Throwable,将其转为Result,再交给框架渲染
  6. 如果是其它非Result数据,将其转为Result,再交给框架渲染

代码:

//这个注解可继承,用于支持子类的验证
//
@Valid
public class UapiBase implements Render {
    @Override
    public void render(Object obj, Context ctx) throws Throwable {
        if (obj == null) {
            return;
        }

        if (obj instanceof String) {
            //普通字符串,直接输出
            ctx.output((String) obj);
        } else if (obj instanceof ModelAndView) {
            //视图模型,直接渲染
            ctx.render(obj);
        } else {
            if (obj instanceof UapiCode) {
                //此处是重点,把一些特别的类型进行标准化转换
                //
                UapiCode err = (UapiCode) obj;
                obj = Result.failure(err.getCode(), UapiCodes.getDescription(err));
            } else if (obj instanceof Throwable) {
                //此处是重点,把异常进行标准化转换
                //
                Throwable err = (Throwable) obj;
                obj = Result.failure(err.getMessage());
            } else if(obj instanceof Result == false){
                //否则做为成功数据,格式化为 Result 结构
                //
                obj = Result.succeed(obj);
            }

            ctx.render(obj); 
            //或者调用特定接口直接输出:ctx.outputAsJson(JSON.toJson(obj));
        }
    }
}

2、接口基类应用示例

示例,白名单检测接口

此接口做个白名单检测。如果成功,则返加符串:OK

@Controller
public class CMD_list_check extends UapiBase {
    //此处的@NotEmpty验证,如果没通过会抛出UapiCode
    @NotEmpty({"type", "value"})
    @Mapping("/list/check/")
    public String cmd_exec(Context ctx, String type, String value) throws Exception {
        String tags = ctx.param("tags", "");

        if (tags.contains("client")) {
            if (DbWaterCfgApi.whitelistIgnoreClient()) {
                return "OK";
            }
        }

        if (DbWaterCfgApi.isWhitelist(tags, type, value)) {
            return ("OK");
        } else {
            return (value + ",not is whitelist!");
        }
    }
}

示例,通知推送接口

此接口只能白名单里的IP方可调用。执行后返回:Result

//此处的@Whitelist验证,如果没通过会抛出UapiCode
@Whitelist
@Controller
public class CMD_alarm_push extends UapiBase {
    //此处的@NotEmpty验证,如果没通过会抛出UapiCode
    @NotEmpty({"msg", "target"})
    @Mapping("/alarm/push/")
    public Result cmd_exec(String msg, String target) throws Exception {

        List<String> list = new ArrayList<String>();
        for (String str : target.split(",")) {
            if (str.equals("@alarm")) {
                List<String> mobiles = DbWaterCfgApi.getAlarmMobiles();

                list.addAll(mobiles);
            } else {
                list.add(str);
            }
        }

        String rest = HeiheiApi.push(Config.water_service_name, list, msg);

        if (TextUtils.isEmpty(rest) == false) {
            return Result.succeed(rest);
        } else {
            return Result.failure();
        }
    }
}

示例,配置获取接口

此接口返回一组配置,以 List 类型返回

//@Logging是个拦截器,会对请求输入进行记录
@Logging
//此处的@Whitelist验证,如果没通过会抛出UapiCode
@Whitelist
@Controller
public class CMD_cfg_get extends UapiBase {
    //此处的@NotEmpty验证,如果没通过会抛出UapiCode
    @NotEmpty("tag")
    @Mapping("/cfg/get/")
    public List<ConfigModel> cmd_exec(String tag) throws Throwable {
        return DbWaterCfgApi.getConfigByTag(tag);
    }
}

此文的渲染控制重点是对抛出来的UapiCode和Throwable,进行有效的控制并以统一的Result形态输出。对外接口开发时,还是效果可期的。当然,也可以用此特性干点别的什么事儿。