午餐

关于

午餐旨在实现尽可能简单和精简的配置。开发一个与REST API通信的应用程序应该非常简单。其他试图解决相同问题的项目最终总是会有很多样板代码或映射关系。

目前，兼容传统由Rails提供的REST API。也许（希望如此）在未来，午餐将覆盖绝大多数REST服务。欢迎发送任何拉取请求！

以下是午餐的一些功能：

• 本地/远程模型之间完整资源映射

  • 路由映射：一个Post模型与路由/posts匹配。
  • 服务器的id属性会自动映射到本地model.remoteId（或者如果您想覆盖默认行为，可以是任何其他本地变量）。
  • 创建与更新 - 根据model.remote.id是否存在，调用save()将创建或更新资源（即POST /posts或PATCH /posts/42）。
  • 嵌套资源映射。
  • 当调用model.remote.save时，只有自获取以来已更改的属性才会发送到服务器。
  • JSON响应字段直接映射到模型属性。无需手动处理JSON（除了自定义错误处理器）。
  • 自动将snake_case属性映射到Swift标准camelCase，反之亦然。
  • 所有网络任务都是异步处理的。

• 错误处理

  • 我们很遗憾地发现，很多开发者实际上完全忽略了错误（尤其是在原型设计或MVP时），因此我们添加了一个无设置默认处理器：默认情况下，错误（从无网络错误到模型验证错误）会在UIAlertView中提醒。为了避免最终用户被过度淹没，只会提醒第一个错误。
  • 然而，仍然易于自定义（只需设置自己的实现到Luncheon.Options.errorHandler）。

• 可以通过attributes()和attributesUnderscore()轻松获取模型属性值作为字典。

• 灵活性

  • 午餐利用了Swift协议扩展，这意味着您的午餐模型可以继承其他库，这意味着您可以与CoreData或其他第三方库使用相同的对象。

用法

源代码中包含了一个示例应用程序。

配置可以像提供baseUrl一样简单

Luncheon.Options.baseUrl = "http://jsonplaceholder.typicode.com"

定义一个模型

class Post: NSObject, Lunch {
    dynamic var title : String?

    required override init() {
      super.init()
    }
}

获取并打印出帖子列表

// GET /posts
Post.remote.all { (posts: [Post] in
    for post in posts {
        println(post.title)
    }
}

创建一个新的帖子并打印出响应资源的属性

let myPost = Post()
myPost.title = "Wow, Luncheon saves me so much time"

// POST /posts
myPost.remote.save { post in
    println(post.attributes())
}

获取现有的帖子并打印其属性

// GET /posts/42
Post.remote.find(42) { post in println(post.attributes()) }

或者一个帖子的一些关联评论

// GET /posts/42/comments
post.remote.associated(Comment.self).all { (comments: [Comment]) in
    for comment in comments {
        println(comment.title)
    }
}

安装

Luncheon可以通过CocoaPods使用。要安装它，只需将以下行添加到您的Podfile中

pod "Luncheon", git: "https://github.com/Dan2552/Luncheon.git"

主要贡献者

• Daniel Inkpen
• Tim Preuß

许可

Luncheon受MIT许可证的许可。有关更多信息，请参阅LICENSE文件。