跳到正文
Willh的个人博客 记录 · 思考 · 分享
《Flutter实战·第二版》

15.3 Model类定义

本节我们先梳理一下APP中将用到的数据,然后生成相应的Dart Model类。Json文件转Dart Model的方案采用前面介绍过的 json_model 包方案

Github账号信息

登录Github后,我们需要获取当前登录者的Github账号信息,Github API接口返回Json结构如下:

1{
2  "login": "octocat", //用户登录名
3  "avatar_url": "https://github.com/images/error/octocat_happy.gif", //用户头像地址
4  "type": "User", //用户类型,可能是组织
5  "name": "monalisa octocat", //用户名字
6  "company": "GitHub", //公司
7  "blog": "https://github.com/blog", //博客地址
8  "location": "San Francisco", // 用户所处地理位置
9  "email": "octocat@github.com", // 邮箱
10  "hireable": false,
11  "bio": "There once was...", // 用户简介
12  "public_repos": 2, // 公开项目数
13  "followers": 20, //关注该用户的人数
14  "following": 0, // 该用户关注的人数
15  "created_at": "2008-01-14T04:33:35Z", // 账号创建时间
16  "updated_at": "2008-01-14T04:33:35Z", // 账号信息更新时间
17  "total_private_repos": 100, //该用户总的私有项目数(包括参与的其它组织的私有项目)
18  "owned_private_repos": 100 //该用户自己的私有项目数
19  ... //省略其它字段
20}

我们在“jsons”目录下创建一个“user.json”文件保存上述信息。

API缓存策略信息

由于Github服务器在国内访问速度较慢,我们对Github API应用一些简单的缓存策略。我们在“jsons”目录下创建一个“cacheConfig.json”文件缓存策略信息,定义如下:

1{
2  "enable":true, // 是否启用缓存
3  "maxAge":1000, // 缓存的最长时间,单位(秒)
4  "maxCount":100 // 最大缓存数
5}

用户信息

用户信息(Profile)应包括如下信息:

  1. Github账号信息;由于我们的APP可以切换账号登录,且登录后再次打开则不需要登录,所以我们需要对用户账号信息和登录状态进行持久化。
  2. 应用使用配置信息;每一个用户都应有自己的APP配置信息,如主题、语言、以及数据缓存策略等。
  3. 用户注销登录后,为了便于用户在退出APP前再次登录,我们需要记住上次登录的用户名。

需要注意的是,目前Github有三种登录方式,分别是账号密码登录、oauth授权登录、二次认证登录;这三种登录方式的安全性依次加强,但是在本示例中,为了简单起见,我们使用账号密码登录,因此我们需要保存用户的密码。

注意:在这里需要提醒读者,在登录场景中,保护用户账号安全是一个非常重要且永恒的话题,在实际开发中应严格杜绝直接明文存储用户账密的行为。

我们在“jsons”目录下创建一个“profile.json”文件,结构如下:

1{
2  "user":"$user", //Github账号信息,结构见"user.json"
3  "token":"", // 登录用户的token(oauth)或密码
4  "theme":5678, //主题色值
5  "cache":"$cacheConfig", // 缓存策略信息,结构见"cacheConfig.json"
6  "lastLogin":"", //最近一次的注销登录的用户名
7  "locale":"" // APP语言信息
8}

项目信息

由于APP主页要显示其所有项目信息,我们在“jsons”目录下创建一个“repo.json”文件保存项目信息。通过参考Github 获取项目信息的API文档,定义出最终的“repo.json”文件结构,如下:

1{
2  "id": 1296269,
3  "name": "Hello-World", //项目名称
4  "full_name": "octocat/Hello-World", //项目完整名称
5  "owner": "$user", // 项目拥有者,结构见"user.json"
6  "parent":"$repo", // 如果是fork的项目,则此字段表示fork的父项目信息
7  "private": false, // 是否私有项目
8  "description": "This your first repo!", //项目描述
9  "fork": false, // 该项目是否为fork的项目
10  "language": "JavaScript",//该项目的主要编程语言
11  "forks_count": 9, // fork了该项目的数量
12  "stargazers_count": 80, //该项目的star数量
13  "size": 108, // 项目占用的存储大小
14  "default_branch": "master", //项目的默认分支
15  "open_issues_count": 2, //该项目当前打开的issue数量
16  "pushed_at": "2011-01-26T19:06:43Z",
17  "created_at": "2011-01-26T19:01:12Z",
18  "updated_at": "2011-01-26T19:14:43Z",
19  "subscribers_count": 42, //订阅(关注)该项目的人数
20  "license": { // 该项目的开源许可证
21    "key": "mit",
22    "name": "MIT License",
23    "spdx_id": "MIT",
24    "url": "https://api.github.com/licenses/mit",
25    "node_id": "MDc6TGljZW5zZW1pdA=="
26  }
27  ...//省略其它字段
28}

生成Dart Model类

现在,我们需要的Json数据已经定义完毕,现在只需要运行json_model package提供的命令来通过json文件生成相应的Dart类:

1flutter packages pub run json_model

命令执行成功后,可以看到lib/models文件夹下会生成相应的Dart Model类:

1├── models
2│   ├── cacheConfig.dart
3│   ├── cacheConfig.g.dart
4│   ├── index.dart
5│   ├── profile.dart
6│   ├── profile.g.dart
7│   ├── repo.dart
8│   ├── repo.g.dart
9│   ├── user.dart
10│   └── user.g.dart

数据持久化

我们使用shared_preferences包来对登录用户的Profile信息进行持久化。shared_preferences是一个Flutter插件,它通过Android和iOS平台提供的机制来实现数据持久化。由于shared_preferences的使用非常简单,读者可以自行查看其文档,在此不再赘述。