Flutter网络请求简化插件rest_simplified的使用

Flutter网络请求简化插件rest_simplified的使用

Rest Simplified 是一个帮助访问 RESTful 后端的简单库。当前版本处于实验阶段，不建议在生产环境中使用。

示例

以下是一个用于测试的示例：

RestSimplified rs = RestSimplified.build('https://catfact.ninja');
rs.addFromJsonMapParser<CatFact>(CatFactJsonMapper());
rs.addPath<CatFact>(Method.get, '/fact');

ServiceResult result = await rs.getRestAccessor().get<CatFact>();
expect(result.httpCode, 200);

CatFact catFact = result.entity;

expect(catFact.fact!.length, catFact.length);
print(catFact.fact);

简单的REST GET示例

void getExampleCall() async {
  // 初始化 RestSimplified 实例并设置基础URL
  RestSimplified rs = RestSimplified.build('https://catfact.ninja');
  
  // 添加从JSON映射解析器
  rs.addFromJsonMapParser<CatFact>(CatFactJsonMapper());
  
  // 添加路径和HTTP方法
  rs.addPath<CatFact>(Method.get, '/fact');

  // 发起GET请求并获取结果
  ServiceResult result = await rs.getRestAccessor().get<CatFact>();

  // 解析返回的对象
  CatFact catFact = result.entity;
  print(catFact.fact); // 打印事实内容
  print(catFact.length); // 打印事实长度
}

// 定义 CatFact 类
class CatFact {
  String? fact;
  int? length;
}

// 定义 CatFactJsonMapper 类实现 FromJsonParser 接口
class CatFactJsonMapper implements FromJsonParser {
  [@override](/user/override)
  List toList(json) {
    // 不处理列表
    throw UnimplementedError();
  }

  [@override](/user/override)
  toObject(Map<String, dynamic> json) {
    CatFact fact = CatFact();
    fact.fact = json['fact']; // 设置事实内容
    fact.length = json['length']; // 设置事实长度
    return fact;
  }
}

使用POST请求进行登录然后GET请求以显示一些信息

// 定义 JSONContentHeader 类实现 HeaderBuilder 接口
class JSONContentHeader implements HeaderBuilder {
  [@override](/user/override)
  Map<String, String> get() {
    Map<String, String> header = {};
    header['Content-Type'] = 'application/json'; // 根据服务器需求添加 Content-Type 头
    return header;
  }
}

// 定义 RestFactory 类
class RestFactory {
  static final RestSimplified rest = RestSimplified.build(
      'http://localhost:3000',
      defaultHeaderBuilder: JSONContentHeader());

  // 初始化方法，在 main.dart 中调用
  static void init() {
    rest.addFromJsonMapParser<UserDTO>(UserJsonToUser());
    rest.addToJsonMapParser<SigninDTO>(SigninToJson());
    
    // 添加路径和HTTP方法
    rest.addPath<SigninDTO>(Method.post, '/users/signin');
    rest.addPath<UserDTO>(Method.get, '/users/whoami/');
  }
}

// 定义 SigninDTO 类
class SigninDTO {
  String email;
  String password;
  SigninDTO(this.email, this.password);
}

// 定义 UserDTO 类
class UserDTO {
  String? email;
  String? recoveryEmail;
  String? publicKey;
}

// 定义 SigninToJson 类实现 ToJsonMapParser 接口
class SigninToJson extends ToJsonMapParser<SigninDTO> {
  [@override](/user/override)
  Map<String, String> toMap(SigninDTO dto) {
    Map<String, String> map = {};
    map['email'] = dto.email;
    map['password'] = dto.password;
    return map;
  }
}

// 定义 UserJsonToUser 类实现 FromJsonParser 接口
class UserJsonToUser extends FromJsonParser<UserDTO> {
  [@override](/user/override)
  UserDTO toObject(Map<String, dynamic> json) {
    UserDTO user = UserDTO();
    user.email = json['email'];
    user.recoveryEmail = json['recoveryEmail'];
    user.publicKey = json['publicKey'];
    return user;
  }
}

// 在登录小部件中调用登录方法
void _call(Map<String, dynamic> form) {
  SigninDTO signin = SigninDTO(form['email'], form['password']);
  Future<ServiceResult> result = RestFactory.rest
      .getRestAccessor()
      .post<SigninDTO, UserDTO>(signin, headerBuilder: JSONHeader());
  result.then((value) => _handleResponse(value.entity, value.headers));
}

void _handleResponse(UserDTO entity, Map<String, String> headers) {
  // 进行额外的检查
  SimpleRouter.forwardAndRemoveAll(const WhoAmIPage()); // 示例使用 SimpleRouter
}

// 在显示用户信息的小部件中
[@override](/user/override)
void initState() {
  // 发起GET请求获取用户信息
  Future<ServiceResult> whoami =
  RestFactory.rest.getRestAccessor().get<UserDTO>();
  whoami.then((value) => _handleResult(value.entity));
  super.initState();
}

void _handleResult(UserDTO user) {
  // 更新屏幕上的字段值
  setState(() {
    _email = user.email ?? '';
    _recoveryEmail = user.recoveryEmail ?? '';
    _publicKey = user.publicKey ?? '';
    _loading = false;
  });
}