目录
  • 接口设计
  • 数据库设计
  • 逻辑代码
    • 实体类
    • jpa
    • controller
    • 返回示例
  • 最后

    夏天来了,是不是要给App换个夏天主题的皮肤呢?但是夏天过去后再换回默认皮肤难道还需要再重新发版么。不需要的,下面来编写个通用的配置项接口,可以做个让运营可配置的APP换肤功能。只要切换参数值,就可以让App换回原来的皮肤。

    接口设计

    在设计接口前,需要考虑的是可能不只换肤需要页面联动变化,其他功能也需要,例如APP不同的版本,某个功能是否展示。这种通用的配置项,都可以使用一个接口返回。

    所以考虑扩展性,使用自定义key\value方式传值,和前端约定功能的key、value来设置APP展示效果就可以啦。

    body需要包含最基本的是参数的key、参数的value。 例如 {"key":"skin","value":"summer"}

    数据库设计

    由于夏季换肤功能是保证可复用性,比如总会出的某项活动,不需要每次都要研发的功能,就可以找到原有的配置继续使用。所以可将配置类存储到数据库表中,并且在后台运营系统增加切换设置功能页面。

    DROP TABLE IF EXISTS app_config;
    CREATE TABLE app_config(
        ID VARCHAR(32) NOT NULL   COMMENT 'ID' ,
        KEY VARCHAR(255)    COMMENT '配置标识' ,
        VALUE VARCHAR(255)    COMMENT '配置值' ,
        CREATED_TIME DATETIME    COMMENT '创建时间' ,
        UPDATED_BY VARCHAR(32)    COMMENT '更新人' ,
        UPDATED_TIME DATETIME    COMMENT '更新时间' ,
        CREATED_BY VARCHAR(255)    COMMENT '创建人' ,
        REMARK VARCHAR(255)    COMMENT '备注' ,
        PRIMARY KEY (ID)
    )  COMMENT = 'App配置表';

    逻辑代码

    实体类

    @ApiModel(value = "App配置表",description = "")
    @Table(name="app_config")
    public class AppConfig implements Serializable,Cloneable{
        /** ID */
        @Id
        @GeneratedValue
        @ApiModelProperty(name = "ID",notes = "")
        private String id ;
        /** 配置标识 */
        @ApiModelProperty(name = "配置标识",notes = "")
        private String key ;
        /** 配置值 */
        @ApiModelProperty(name = "配置值",notes = "")
        private String value ;
        /** 创建时间 */
        @ApiModelProperty(name = "创建时间",notes = "")
        private Date createdTime ;
        /** 更新人 */
        @ApiModelProperty(name = "更新人",notes = "")
        private String updatedBy ;
        /** 更新时间 */
        @ApiModelProperty(name = "更新时间",notes = "")
        private Date updatedTime ;
        /** 创建人 */
        @ApiModelProperty(name = "创建人",notes = "")
        private String createdBy ;
        /** 备注 */
        @ApiModelProperty(name = "备注",notes = "")
        private String remark ;
    }

    jpa

    添加Repository,用于获取数据库中App配置信息。

    public interface AppConfigRepository extends JpaRepository<AppConfig, String> {
    }

    controller

    编写获取配置信息方法,一次性拿出全部配置,在前端取配置的key,根据具体业务处理接下来的换肤逻辑。

    @GetMapping("/config")
    public AppConfigDTO getAppConfigs() {
       return appConfigRepository.findAll();
    }

    返回示例

    获取到不同的value,来切换App的皮肤设置,是放在后端可维护的全局配置,列举如下不同的设置。

    • 夏季皮肤设置:
    {
        "key": "skin",
        "value": "Summer"
    }
    • 春节皮肤设置:
    {
        "key": "skin",
        "value": "SpringFestival"
    }

    最后

    本文是以夏天换肤一个功能视角带入的配置接口,很多App中可以使用通用配置的地方都可以按上面增加的这个配置类进行切换本身配置,让我们的App更灵活,减少发版次数。

    声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。