社区首页 >专栏 >springboot+jpa+spring-data-rest 快速实现rest应用

springboot+jpa+spring-data-rest 快速实现rest应用

吟风者

发布于 2020-02-10 04:00:38

77200

代码可运行

文章被收录于专栏：吟风者吟风者

运行总次数：0

代码可运行

本例使用springboot，并使用了 spring-data-rest 和 spring-data-jpa

此二者结合：真的可以实现10分钟创建一个rest应用

我们创建一个person表，并创建person的entity和repository，让repository继承JpaRepository。

关键的来了：@RepositoryRestResource(collectionResourceRel = "person", path = "person") 我们给repository加上一个@RepositoryRestResource注解，我们来启动项目，看看此注解的魔力。

启动项目

访问：htttp://localhost:8080/person 得到的结果如下：

{
    "_embedded": {
        "person": []
    },
    "_links": {
        "self": {
            "href": "http://localhost:8080/person{?page,size,sort}",
            "templated": true
        },
        "profile": {
            "href": "http://localhost:8080/profile/person"
        },
        "search": {
            "href": "http://localhost:8080/person/search"
        }
    },
    "page": {
        "size": 20,
        "totalElements": 0,
        "totalPages": 0,
        "number": 0
    }
}

我们看到 person节点并无内容。

添加person

我们使用POST方式访问 http://localhost:8080/person 并提交如下 JSON 数据：

{"name": "王五", "age": "18","address":"上海"}

查看person 及 person 列表

我们再次在浏览器中访问（GET） http://localhost:8080/person。得到的结果中，JSON数据和第一步中一样，person节点中不再是空的了。

{
  "_embedded": {
    "person": [
      {
        "name": "王五",
        "age": 18,
        "address": "上海",
        "_links": {
          "self": {
            "href": "http://localhost:8080/person/4"
          },
          "person": {
            "href": "http://localhost:8080/person/4"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/person{?page,size,sort}",
      "templated": true
    },
    "profile": {
      "href": "http://localhost:8080/profile/person"
    },
    "search": {
      "href": "http://localhost:8080/person/search"
    }
  },
  "page": {
    "size": 20,
    "totalElements": 1,
    "totalPages": 1,
    "number": 0
  }
}

我们可以继续多添加几条数据，方便下面展示查询。在添加多条信息之后，如果想查看某个person的详情，例如：http://localhost:8080/person/7

{
  "name": "",
  "age": 18,
  "address": "上海",
  "_links": {
    "self": {
      "href": "http://localhost:8080/person/5"
    },
    "person": {
      "href": "http://localhost:8080/person/5"
    }
  }
}

条件查询

假设我们需要根据用户名查询用户，我们在PersonRepository中添加一个方法findByNameStartingWith. 托spring-data-jpa的福，我们只需要写这样的一行代码，然后什么都不用做，spring-data-jpa会解析findByNameStartingWith并应用到查询上。

List<Person> findByNameStartingWith(@Param("name") String name);

写好上面的代码之后，我们重启项目，访问http://localhost:8080/person/search结果如下：

{
  "_links": {
    "nameStartsWith": {
      "href": "http://localhost:8080/person/search/nameStartsWith{?name}",
      "templated": true
    },
    "self": {
      "href": "http://localhost:8080/person/search"
    }
  }
}

我们可以看到，这里已经列出了当前可用的search方法。我们访问：http://localhost:8080/person/search/nameStartsWith?name=王五

{
  "_embedded": {
    "person": [
      {
        "name": "王五",
        "age": 18,
        "address": "上海",
        "_links": {
          "self": {
            "href": "http://localhost:8080/person/4"
          },
          "person": {
            "href": "http://localhost:8080/person/4"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/person/search/nameStartsWith?name=%E7%8E%8B%E4%BA%94"
    }
  }
}

我们可以看到，这里通过nameStartsWith?name=王五找到了一个人：王五

分页查询

为了演示分页，我们先多添加几条用户数据。在第一步中展示的结果中，我们可以看到这样的一行数据： http://localhost:8080/person{?page,size,sort} 这提示了我们分页的使用方法，我们来访问http://localhost:8080/person?page=0&size=3 试试，即：访问第1页数据，页大小是3。下面贴出关键结果的节点：

{
  "_embedded": {
    "person": [
      {
        "name": "",
        "age": 18,
        "address": "上海",
        "_links": {
          "self": {
            "href": "http://localhost:8080/person/5"
          },
          "person": {
            "href": "http://localhost:8080/person/5"
          }
        }
      },
      {
        "name": "王五",
        "age": 18,
        "address": "上海",
        "_links": {
          "self": {
            "href": "http://localhost:8080/person/4"
          },
          "person": {
            "href": "http://localhost:8080/person/4"
          }
        }
      },
      {
        "name": "",
        "age": 18,
        "address": "上海",
        "_links": {
          "self": {
            "href": "http://localhost:8080/person/6"
          },
          "person": {
            "href": "http://localhost:8080/person/6"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://localhost:8080/person{&sort}",
      "templated": true
    },
    "profile": {
      "href": "http://localhost:8080/profile/person"
    },
    "search": {
      "href": "http://localhost:8080/person/search"
    }
  },
  "page": {
    "size": 3,
    "totalElements": 3,
    "totalPages": 1,
    "number": 0
  }
}

确实查到了数据，结果对不对呢？根据上面的从上面的结果看出，我们添加3条数据，页大小是3，所以： 总页数 = 1 第一页 3条数据

controller 去哪里了

到目前为止，我们只写了很少的代码，但是却已经实现了增删改查。我们甚至连 controller都没有写，就访问了这么多的rest url。我们只通过@RepositoryRestResource(collectionResourceRel = "person", path = "person")在 dao 中就能够把 /path路径暴露出来。边一切都有了，这就是spring-data-rest的魔力。

自定义 spring-data-rest 魔力之外的controller可以吗

当然可以了，上面我们所访问的 /person/* 的地址，是从dao中通过 @RepositoryRestResource 注解暴露出去的。那么现在我们就手写一个controller，访问路径也叫/person,即：@RequestMapping("/person")

@RestController
@RequestMapping("/person")
public class PersonController {

    @RequestMapping("/hello")
    public String hello() {
        return " Hello,welcome to the normal controller! ";
    }

}

我们自己创建的controller访问路径也是，/person 还创建了一个自定义的 hello方法，这个/person 和dao里边暴露的/person 能共存，并和谐相处吗？我们访问看看：http://localhost:8080/person/hello 我们在浏览器中可以看到：