写设计文档的示例

设计的重点

1. 新功能的数据流是怎么样的
2. 有没有异步处理部分，如何工作
3. 如何使用缓存，如何使用库。
4. 解决方案新增或更改了多少模块，各模块的作用是什么
5. 为什么你的解决方案能达到一定的并发和稳定性要求。

需求分析：

主要需求包括如下几点

• 支持按城市，按类型，按XXX设置广告。
• XXX
• XXX
• XXX

(列举出主要的需求点、需要特别关注的点)

非功能性需求会考虑如下的点

• 性能要求高。
• 会通过定时job刷新缓存。
• XXX

设计要点

• 所有的访问不能打数据库，用于保证性能。
• 通过job来更新缓存，供前端调用。
• XXX

主要流程图

（根据业务可选）

调用序列图示例

主要接口定义

注：为了保证文档尽可能合理大小
1. 不是让大家把所有的API全列出来，需要列出来的是本功能需要的主要接口
2. 入参出参也不需要特别完整，但重点部分需要列举出来
1. 退出圈子

/*
    para {
        ...
        userID:
    }
    return:{
    }
*/
    @RequestMapping(value = "quite", method = RequestMethod.POST)
    public ReturnData quiteCircle(@RequestBody Map<String, Object> jsonPara) throws Exception {
        ...
        //重要逻辑是：
        // 1. aaa
        // 2. bbb
    }

1. 加入圈子

/*
*/
    @RequestMapping(value = "add", method = RequestMethod.POST)
    public ReturnData addCircle(@RequestBody Map<String, Object> jsonPara) throws Exception {
    }

数据库定义

不需要把所有字段全列举出来，主要列举的是与逻辑非常相关的部分。以及描述与性能相关的部分。
1. 库A
主要作用是：保存用户关系的信息

2. 库B
主要作用是：保存大V用户关系

主要的查询关系

1 获取用户粉丝列表

select * from A where ...

2 获得粉丝数

select * from A where ...

缓存定义

ES设计

暂无

队列定义及格式

1 加入圈子到搜索

    "topic":"shensou"
    "format":{
        "type":"joinToCircle"
        "data":{
                "usrID":"加上字段描述"
                "..."
            }
    }

有哪些接口测试

为了测试上面功能，我们做了如下的测试