{"id":10007051,"date":"2023-01-09T18:12:56","date_gmt":"2023-01-09T10:12:56","guid":{"rendered":"https:\/\/ityet.com\/?p=10007051"},"modified":"2023-01-09T18:12:56","modified_gmt":"2023-01-09T10:12:56","slug":"%e5%88%b0%e5%ba%95%e4%bb%80%e4%b9%88%e6%a0%b7%e7%9a%84-rest-%e6%89%8d%e6%98%af%e6%9c%80%e4%bd%b3-rest%ef%bc%9f","status":"publish","type":"post","link":"https:\/\/itmax.cn\/?p=10007051","title":{"rendered":"\u5230\u5e95\u4ec0\u4e48\u6837\u7684 REST \u624d\u662f\u6700\u4f73 REST\uff1f"},"content":{"rendered":"

\u8bf4\u8d77 REST API\uff0c\u5c0f\u4f19\u4f34\u4eec\u591a\u591a\u5c11\u5c11\u90fd\u6709\u542c\u8bf4\u8fc7\uff0c\u4f46\u662f\u5982\u679c\u8ba9\u4f60\u8be6\u7ec6\u4ecb\u7ecd\u4e00\u4e0b\u4ec0\u4e48\u662f REST\uff0c\u4f30\u8ba1\u4f1a\u6709\u5f88\u591a\u4eba\u8bb2\u4e0d\u51fa\u6765\uff0c\u6216\u8005\u53ea\u8bb2\u51fa\u6765\u5176\u4e2d\u4e00\u90e8\u5206\u3002<\/p>\n

\u4eca\u5929\u677e\u54e5\u5c31\u6765\u548c\u5927\u5bb6\u4e00\u8d77\u6765\u804a\u4e00\u804a\u5230\u5e95\u4ec0\u4e48\u662f REST\uff0c\u987a\u4fbf\u518d\u6765\u770b\u4e0b Spring HATEOAS \u7684\u7528\u6cd5\u3002<\/p>\n

1. REST \u6210\u719f\u6a21\u578b<\/h2>\n

\u9996\u5148\u5173\u4e8e REST\uff0c\u6709\u4e00\u4e2a\u5927\u4f6c Leonard Richardson \u4e3a REST \u5b9a\u4e49\u4e86\u4e00\u4e2a\u6210\u719f\u5ea6\u6a21\u578b\uff0c\u4ed6\u4e00\u5171\u5b9a\u4e49\u4e86\u56db\u4e2a\u4e0d\u540c\u7684\u5c42\u6b21\uff0c\u5206\u522b\u5982\u4e0b\uff1a<\/p>\n

    \n
  1. Level0\uff1aWeb \u670d\u52a1\u5355\u7eaf\u7684\u4f7f\u7528 HTTP \u4f5c\u4e3a\u6570\u636e\u4f20\u8f93\u65b9\u5f0f\uff0c\u672c\u8d28\u4e0a\u5c31\u662f\u8fdc\u7a0b\u65b9\u6cd5\u8c03\u7528\uff0c\u5e38\u89c1\u7684 SOAP \u548c RPC \u57fa\u672c\u4e0a\u90fd\u5c5e\u4e8e\u8fd9\u4e00\u7c7b\u3002<\/li>\n
  2. Level1\uff1a\u5728\u8fd9\u4e00\u7ea7\u522b\u4e0a\uff0c\u5f15\u5165\u4e86\u8d44\u6e90\u7684\u6982\u5ff5\uff0c\u670d\u52a1\u7aef\u7684\u6bcf\u4e00\u4e2a\u8d44\u6e90\uff0c\u90fd\u6709\u4e00\u4e2a\u5bf9\u5e94\u7684\u64cd\u4f5c\u5730\u5740\u3002<\/li>\n
  3. Level2\uff1a\u5728\u8fd9\u4e00\u7ea7\u522b\u4e0a\uff0c\u6211\u4eec\u5f15\u5165\u4e86\u4e0d\u540c\u7684 HTTP \u8bf7\u6c42\u65b9\u6cd5\u6765\u63cf\u8ff0\u4e0d\u540c\u7684\u64cd\u4f5c\uff0c\u4f8b\u5982 GET \u8868\u793a\u67e5\u8be2\u3001POST \u8868\u793a\u63d2\u5165\u3001PUT \u8868\u793a\u66f4\u65b0\u3001DELETE \u8868\u793a\u5220\u9664\uff0c\u5e76\u4e14\u4f7f\u7528 HTTP \u7684\u72b6\u6001\u7801\u6765\u8868\u793a\u4e0d\u540c\u7684\u54cd\u5e94\u7ed3\u679c\u3002\u4e00\u822c\u6765\u8bf4\uff0c\u5927\u5bb6\u5728\u65e5\u5e38\u7684\u63a5\u53e3\u5f00\u53d1\u4e2d\uff0c\u57fa\u672c\u4e0a\u90fd\u80fd\u505a\u5230\u8fd9\u4e00\u5c42\u7ea7\u3002\u4f46\u662f\u8fd9\u8fd8\u4e0d\u662f\u6700\u4f73\u7ed3\u679c\u3002<\/li>\n
  4. Level3\uff1a\u6309\u7167 Leonard Richardson \u7684\u610f\u601d\uff0c\u8fd9\u4e00\u5c42\u7ea7\u7684 REST \u57fa\u4e8e HATEOAS\uff08Hypertext As The Engine Of Application State\uff09\uff0c\u5728\u8fd9\u4e00\u7ea7\u522b\u4e0a\uff0c\u9664\u4e86\u8fd4\u56de\u8d44\u6e90\u7684 JSON \u4e4b\u5916\uff0c\u8fd8\u4f1a\u989d\u5916\u8fd4\u56de\u4e00\u7ec4 Link\uff0c\u8fd9\u7ec4 Link \u63cf\u8ff0\u4e86\u5bf9\u4e8e\u8be5\u8d44\u6e90\u53ef\u4ee5\u505a\u54ea\u4e9b\u64cd\u4f5c\uff0c\u4ee5\u53ca\u5177\u4f53\u7684\u8be5\u600e\u4e48\u505a\u3002<\/li>\n<\/ol>\n

    \u5728\u65e5\u5e38\u7684\u5f00\u53d1\u4e2d\uff0c\u6211\u4eec\u4e00\u822c\u90fd\u662f\u53ea\u5b9e\u73b0\u5230 Level2 \u8fd9\u4e00\u5c42\u7ea7\uff0c\u771f\u6b63\u505a\u5230 Level3 \u7684\u4f30\u8ba1\u5f88\u5c11\uff0c\u4e0d\u8fc7\u867d\u7136\u5728\u5de5\u4f5c\u4e2d\u4e00\u822c\u4e0d\u4f1a\u505a\u5230 Level3 \u8fd9\u4e00\u5c42\u7ea7\uff0c\u4f46\u662f\uff0c\u6211\u76f8\u4fe1\u5f88\u591a\u5c0f\u4f19\u4f34\u5e94\u8be5\u662f\u89c1\u8fc7 Level3 \u5c42\u7ea7\u7684 REST \u662f\u5565\u6837\u5b50\u7684\uff0c\u7279\u522b\u662f\u770b\u8fc7 vhr \u89c6\u9891\u7684\u5c0f\u4f19\u4f34\uff0c\u677e\u54e5\u5728\u5176\u4e2d\u8bb2\u8fc7\uff0c\u901a\u8fc7 Spring Data Jpa+Spring Rest Repositories \u5b9e\u73b0\u7684 CURD \u63a5\u53e3\uff0c\u5176\u5b9e\u5c31\u662f\u4e00\u4e2a\u8fbe\u5230\u4e86 Level3 \u5c42\u7ea7\u7684 REST\u3002<\/p>\n

    2. Spring HATEOAS<\/h2>\n

    \u90a3\u4e48\u63a5\u4e0b\u6765\u6211\u5148\u7528 Spring HATEOAS \u5199\u4e00\u4e2a\u7b80\u5355\u7684 REST\uff0c\u7136\u540e\u7ed3\u5408\u8fd9\u4e2a\u6848\u4f8b\u6765\u548c\u5c0f\u4f19\u4f34\u4eec\u804a\u4e00\u804a\u5230\u5e95 Spring HATEOAS \u6709\u4f55\u4e0d\u4e00\u6837\u7684\u5730\u65b9\u3002<\/p>\n

    \u9996\u5148\u6211\u4eec\u521b\u5efa\u4e00\u4e2a Spring Boot \u5de5\u7a0b\uff0c\u5f15\u5165 Web \u548c Spring HATEOAS \u4f9d\u8d56\uff0c\u5982\u4e0b\uff1a<\/p>\n

    \"\"<\/p>\n

    \u521b\u5efa\u597d\u4e4b\u540e\uff0c\u6211\u4eec\u9996\u5148\u521b\u5efa\u4e00\u4e2a User \u5b9e\u4f53\u7c7b\uff1a<\/p>\n

    public class User extends RepresentationModel {\n    private Integer id;\n    private String username;\n    private String address;\n    \/\/\u7701\u7565 getter\/setter\n}<\/code><\/pre>\n
    \u6ce8\u610f\u8fd9\u4e2a User \u5b9e\u4f53\u7c7b\u9700\u8981\u7ee7\u627f\u81ea RepresentationModel\uff0c\u4ee5\u65b9\u4fbf\u540e\u7eed\u6dfb\u52a0\u4e0d\u540c\u7684 Link\uff08\u4ee5\u524d\u65e7\u7684\u7248\u672c\u9700\u8981\u7ee7\u627f\u81ea ResourceSupport\uff09\u3002<\/p>\n
    \u63a5\u4e0b\u6765\u5199\u4e00\u4e2a\u7b80\u5355\u7684\u6d4b\u8bd5\u63a5\u53e3\u3002<\/p>\n
    \u67e5\u8be2\u6240\u6709\u7528\u6237\uff1a<\/p>\n
    @RestController\n@RequestMapping("\/users")\npublic class UserController {\n\n    @GetMapping\n    public CollectionModel<User> list() {\n        List<User> list = new ArrayList<>();\n        User u1 = new User();\n        u1.setId(1);\n        u1.setUsername("javaboy");\n        u1.setAddress("www.javaboy.org");\n        u1.add(WebMvcLinkBuilder.linkTo(UserController.class).slash(u1.getId()).withSelfRel());\n        list.add(u1);\n        User u2 = new User();\n        u2.setId(2);\n        u2.setUsername("itboy");\n        u2.setAddress("www.itboyhub.com");\n        u2.add(WebMvcLinkBuilder.linkTo(UserController.class).slash(u2.getId()).withSelfRel());\n        list.add(u2);\n        CollectionModel<User> users = CollectionModel.of(list);\n        users.add(WebMvcLinkBuilder.linkTo(UserController.class).withRel("users"));\n        return users;\n    }\n}<\/code><\/pre>\n
    \u5173\u4e8e\u8fd9\u4e2a\u63a5\u53e3\uff0c\u6211\u6765\u8bf4\u51e0\u70b9\uff1a<\/p>\n
      \n
    1. \u9996\u5148\uff0c\u5bf9\u4e8e\u8fd9\u79cd\u8fd4\u56de\u4e00\u4e2a\u96c6\u5408\u6216\u8005\u6570\u7ec4\u7684\u60c5\u51b5\uff0c\u8fd4\u56de\u7684\u7c7b\u578b\u90fd\u662f CollectionModel<User>\u3002<\/li>\n
    2. \u628a\u96c6\u5408\u5f04\u597d\u4e4b\u540e\uff08\u6b63\u5e38\u5e94\u8be5\u53bb\u6570\u636e\u5e93\u4e2d\u67e5\u8be2\uff0c\u6211\u8fd9\u91cc\u7701\u4e8b\u76f4\u63a5\u521b\u5efa\u4e86\uff09\uff0c\u901a\u8fc7 CollectionModel.of(list)<\/code> \u65b9\u6cd5\u53bb\u83b7\u53d6\u4e00\u4e2a CollectionModel<User><\/code> \u5bf9\u8c61\u3002<\/li>\n
    3. \u5bf9\u4e8e\u6bcf\u4e00\u4e2a user \u5bf9\u8c61\uff0c\u6211\u90fd\u6dfb\u52a0\u4e86\u4e00\u4e2a Link \u5bf9\u8c61\uff0cWebMvcLinkBuilder.linkTo(UserController.class).slash(u1.getId()).withSelfRel()<\/code> \u8868\u793a\u751f\u6210\u5f53\u524d\u5bf9\u8c61\u7684\u8bbf\u95ee\u94fe\u63a5\u3002<\/li>\n
    4. WebMvcLinkBuilder.linkTo(UserController.class).withRel("users")<\/code> \u8868\u793a\u8bbf\u95ee\u6240\u6709\u6570\u636e\u7684\u94fe\u63a5\u3002<\/li>\n<\/ol>\n
      \u597d\u4e86\uff0c\u8fd9\u4e2a\u63a5\u53e3\u5199\u5b8c\u4e4b\u540e\uff0c\u6211\u4eec\u8bbf\u95ee\u770b\u4e0b\uff1a<\/p>\n
      \"\"<\/p>\n
      \u53ef\u4ee5\u770b\u5230\uff0c\u8fd4\u56de\u7684\u6bcf\u4e00\u4e2a user \u5bf9\u8c61\u4e2d\uff0c\u90fd\u6709\u4e00\u4e2a\u94fe\u63a5\u8868\u793a\u5982\u4f55\u5355\u72ec\u8bbf\u95ee\u8fd9\u4e2a\u5bf9\u8c61\u3002\u6700\u4e0b\u9762\u8fd8\u6709\u4e00\u4e2a\u8bbf\u95ee\u6240\u6709\u5bf9\u8c61\u7684\u94fe\u63a5\u3002<\/p>\n
      \u5bf9\u4e8e\u4e0a\u9762\u8fd9\u4e2a\u6848\u4f8b\uff0c\u53ef\u80fd\u6709\u5c0f\u4f19\u4f34\u4f1a\u8d28\u7591\uff0c\u96be\u9053\u6211\u4eec\u4ece\u6570\u636e\u5e93\u4e2d\u67e5\u8be2\u51fa\u6765\u7684 List \u96c6\u5408\u90fd\u8981\u904d\u5386\u4e00\u904d\uff0c\u7136\u540e\u7ed9\u6bcf\u4e00\u4e2a User \u6dfb\u52a0\u4e00\u4e2a Link \u5417\uff1f\u5176\u5b9e\u4e0d\u5fc5\uff0c\u6dfb\u52a0 Link \u8fd9\u4e2a\u4e8b\u53ef\u4ee5\u76f4\u63a5\u5728 User \u7c7b\u4e2d\u5b8c\u6210\uff0c\u5982\u4e0b\uff1a<\/p>\n
      public class User extends RepresentationModel {\n    private Integer id;\n    private String username;\n    private String address;\n\n    public User(Integer id) {\n        super(WebMvcLinkBuilder.linkTo(UserController.class).slash(id).withSelfRel());\n        this.id = id;\n    }\n    \/\/\u7701\u7565 getter\/setter\n}<\/code><\/pre>\n
      \u53ef\u4ee5\u770b\u5230\uff0c\u76f4\u63a5\u5728\u6784\u9020\u65b9\u6cd5\u4e2d\u5b8c\u6210\u5373\u53ef\u3002\u6b64\u65f6\u63a5\u53e3\u91cc\u5c31\u4e0d\u7528\u90a3\u4e48\u590d\u6742\u4e86\uff0c\u5982\u4e0b\uff1a<\/p>\n
      @GetMapping\npublic CollectionModel<User> list() {\n    List<User> list = new ArrayList<>();\n    User u1 = new User(1);\n    u1.setUsername("javaboy");\n    u1.setAddress("www.javaboy.org");\n    list.add(u1);\n    User u2 = new User(2);\n    u2.setUsername("itboy");\n    u2.setAddress("www.itboyhub.com");\n    list.add(u2);\n    CollectionModel<User> users = CollectionModel.of(list);\n    users.add(WebMvcLinkBuilder.linkTo(UserController.class).withRel("users"));\n    return users;\n}<\/code><\/pre>\n
      \u90a3\u4e48\u5bf9\u4e8e\u6839\u636e ID \u6765\u67e5\u8be2\u7528\u6237\u7684\u9700\u6c42\uff0c\u6211\u4eec\u4e5f\u5e94\u8be5\u7ed9\u4e00\u4e2a\u63a5\u53e3\u5982\u4e0b\uff1a<\/p>\n
      @RestController\n@RequestMapping("\/users")\npublic class UserController {\n\n    @GetMapping("\/{id}")\n    public EntityModel<User> getOne(@PathVariable Integer id) throws NoSuchMethodException {\n        User u = new User(id);\n        u.setUsername("javaboy");\n        u.setAddress("\u6df1\u5733");\n        u.add(Link.of("http:\/\/localhost:8080\/users\/"+id, "getOne"));\n        Link users = WebMvcLinkBuilder.linkTo(UserController.class).withRel("users");\n        u.add(users);\n        Link link = WebMvcLinkBuilder.linkTo(UserController.class).slash(u.getId()).withSelfRel();\n        u.add(link);\n        Method method = UserController.class.getMethod("getOne", Integer.class);\n        Link link2 = WebMvcLinkBuilder.linkTo(method, id).withSelfRel();\n        u.add(link2);\n        return EntityModel.of(u);\n    }\n}<\/code><\/pre>\n
      \u5173\u4e8e\u8fd9\u4e2a\u63a5\u53e3\uff0c\u6211\u8bf4\u5982\u4e0b\u51e0\u70b9\uff1a<\/p>\n
        \n
      1. \u5982\u679c\u8fd4\u56de\u7c7b\u578b\u662f\u4e00\u4e2a\u5bf9\u8c61\u7684\u8bdd\uff0c\u9700\u8981\u4f7f\u7528 EntityModel<User><\/code> \u7c7b\u578b\u3002<\/li>\n
      2. \u641e\u597d\u8fd4\u56de\u7684\u5bf9\u8c61\u4e4b\u540e\uff0c\u901a\u8fc7 EntityModel.of(u)<\/code> \u65b9\u6cd5\u53ef\u4ee5\u83b7\u53d6\u5230\u76ee\u6807\u6570\u636e\u7c7b\u578b\u3002<\/li>\n
      3. \n
        \u8fd9\u4e2a\u5730\u65b9\uff0c\u4e3a\u4e86\u7ed9\u5c0f\u4f19\u4f34\u4eec\u6f14\u793a\u4e0d\u540c\u7684 Link \u6dfb\u52a0\u65b9\u5f0f\uff0c\u6211\u5199\u4e86\u597d\u591a\u4e2a\uff08\u5355\u7eaf\u4e3a\u4e86\u6f14\u793a\u4e0d\u540c\u7684 Link \u6dfb\u52a0\u65b9\u5f0f\uff09\uff1a<\/p>\n
          \n
        1. Link.of("http:\/\/localhost:8080\/users\/"+id, "getOne")<\/code> \u8fd9\u79cd\u662f\u81ea\u5df1\u7eaf\u624b\u5de5\u53bb\u751f\u6210\u5f53\u524d\u5bf9\u8c61\u7684\u8bbf\u95ee\u94fe\u63a5\uff0c\u5f88\u660e\u663e\u8fd9\u4e0d\u662f\u4e00\u4e2a\u5f88\u597d\u7684\u65b9\u6848\u3002\u5f53\u524d\u5bf9\u8c61\u7684\u8bbf\u95ee\u94fe\u63a5\u5efa\u8bae\u4f7f\u7528\u4e0a\u6587\u4e2d\u63d0\u5230\u7684\u65b9\u5f0f\u3002<\/li>\n
        2. WebMvcLinkBuilder.linkTo(UserController.class).withRel("users")<\/code> \u8fd9\u4e2a\u662f\u751f\u6210\u5f53\u524d\u8fd9\u4e2a Controller \u7684\u8bbf\u95ee\u94fe\u63a5\uff0c\u4e00\u822c\u5c31\u662f\u8bbf\u95ee\u6240\u6709\u7528\u6237\u5bf9\u8c61\u7684\u94fe\u63a5\u3002<\/li>\n
        3. WebMvcLinkBuilder.linkTo(UserController.class).slash(u.getId()).withSelfRel()<\/code> \u524d\u6587\u5df2\u7ecf\u7528\u8fc7\u4e86\uff0c\u4e0d\u591a\u8bf4\u4e86\uff0c\u5b9e\u9645\u5e94\u7528\u4e2d\u5efa\u8bae\u4f7f\u7528\u8fd9\u79cd\u3002<\/li>\n
        4. \u4e5f\u53ef\u4ee5\u6839\u636e\u67d0\u4e00\u4e2a\u65b9\u6cd5\u81ea\u52a8\u751f\u6210\uff0c\u50cf\u8fd9\u6837 WebMvcLinkBuilder.linkTo(method, id).withSelfRel()<\/code>\uff0c\u8fd9\u4e2a\u662f\u751f\u6210\u67d0\u4e00\u4e2a\u5177\u4f53\u65b9\u6cd5\u7684\u8bbf\u95ee\u94fe\u63a5\u3002<\/li>\n<\/ol>\n<\/li>\n<\/ol>\n
          \u597d\u4e86\uff0c\u73b0\u5728\u6211\u4eec\u6765\u770b\u4e0b\u8fd9\u4e2a\u63a5\u53e3\u751f\u6210\u7684 JSON\uff0c\u5982\u4e0b\uff1a<\/p>\n
          \"\"<\/p>\n
          \u751f\u6210\u7684\u8fd9\u6bb5 JSON \u6211\u5c06\u4e4b\u6807\u8bb0\u4e3a\u4e86\u4e09\u90e8\u5206\uff1a<\/p>\n
            \n
          1. \u7b2c\u4e00\u90e8\u5206\uff0cself\uff0c\u5c31\u662f\u81ea\u8eab\u7684\u8bbf\u95ee\u94fe\u63a5\uff0c\u8fd9\u4e09\u4e2a\u94fe\u63a5\u5206\u522b\u662f User \u7684\u6784\u9020\u65b9\u6cd5\uff0c\u4ee5\u53ca\u524d\u9762\u63d0\u5230\u7684 3.3 \u548c 3.4 \u7684\u65b9\u6cd5\u751f\u6210\u7684\u3002<\/li>\n
          2. \u7b2c\u4e8c\u90e8\u5206\uff0cgetOne \u8fd9\u4e2a\uff0c\u662f\u524d\u9762 3.1 \u4e2d\u63d0\u5230\u7684\u65b9\u6cd5\u751f\u6210\u7684\u3002<\/li>\n
          3. \u7b2c\u4e09\u90e8\u5206\uff0cusers \u8fd9\u4e2a\uff0c\u662f\u524d\u9762\u63d0\u5230\u7684 3.2 \u65b9\u6cd5\u751f\u6210\u7684\u3002<\/li>\n<\/ol>\n
            \u5f53\u7136\uff0c\u5176\u5b9e\u8fd9\u5757\u8fd8\u6709\u5f88\u591a\u5176\u4ed6\u7684\u751f\u6210\u94fe\u63a5\u7684\u73a9\u6cd5\uff0c\u4f46\u662f\u6211\u5c31\u4e0d\u4e00\u4e00\u4ecb\u7ecd\u4e86\uff0c\u5c0f\u4f19\u4f34\u4eec\u53ef\u4ee5\u53c2\u8003\u5b98\u65b9\u6587\u6863\uff1a<\/p>\n