模块 org.redkale

注释类型 RestConvert


  • @Documented
    @Target(METHOD)
    @Retention(RUNTIME)
    @Repeatable(RestConverts.class)
    public @interface RestConvert
    只能依附在Service实现类的public方法上, 当方法的返回值以JSON输出时对指定类型的转换设定。
    注意: 如果 type() == void.class 则无视其他参数固定返回 JsonFactory.create().skipAllIgnore(true).getConvert();

    详情见: https://redkale.org

    作者:
    zhangjx
    • 必需元素概要

      所需元素 
      修饰符和类型 必需的元素 说明
      Class type
      类型
    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      String[] convertColumns
      允许输出的字段
      int features
      配置项
      String[] ignoreColumns
      屏蔽的字段
      String[] onlyColumns
      仅显示的字段, 优先级低于skipIgnore
      有值就会忽略ignoreColumns、convertColumns值
      boolean skipIgnore
      是否忽略ConvertColumn.ignore=true的设置, 优先级最高
      值为true时会忽略onlyColumns、ignoreColumns、convertColumns的值
    • 元素详细资料

      • type

        Class type
        类型
        返回:
        Class
      • features

        int features
        配置项
        返回:
        int
        默认值:
        -1
      • skipIgnore

        boolean skipIgnore
        是否忽略ConvertColumn.ignore=true的设置, 优先级最高
        值为true时会忽略onlyColumns、ignoreColumns、convertColumns的值
        返回:
        boolean
        默认值:
        false
      • onlyColumns

        String[] onlyColumns
        仅显示的字段, 优先级低于skipIgnore
        有值就会忽略ignoreColumns、convertColumns值
        返回:
        String[]
        从以下版本开始:
        2.7.0
        默认值:
        {}
      • ignoreColumns

        String[] ignoreColumns
        屏蔽的字段
        返回:
        String[]
        默认值:
        {}
      • convertColumns

        String[] convertColumns
        允许输出的字段
        返回:
        String[]
        默认值:
        {}