如何快速构建基于Spring4.0的Rest API(攻略)
2014-10-25 12:53
253 查看
本文由 ImportNew - 邬柏 翻译自 javacodegeeks。欢迎加入Java小组。转载请参见文章末尾的要求。
这是关于使用Spring MVC创建Web API的另一个教程。这并不是一个非常精细的教程,而仅仅是一个演习(攻略)。本教程旨在创建一个提供服务器端API的应用,并且使用Mongo作为它的数据库,使用Spring Security作为安全框架。
准备开始——POM
由于我是一个maven脑残粉,所以这个项目还是基于maven的。现在Spring 4.0 RC2已经发布了,所以我决定使用最新的依赖管理工具。本文使用的pom.xml如下:使用这个配置创建Spring MVC应用确实非常简单。这里面比较新鲜的东西就是dependencyManagement 元素。详解猛戳这儿:http://spring.io/blog/2013/12/03/spring-framework-4-0-rc2-available
配置
这个应用可以使用JavaConfig完成配置。我把它切分为下面几个部分:
ServicesConfig(服务配置)
无需扫描组件,配置真的非常简单:
PersistenceConfig(持久层配置)
我们想要一个配置了所有可用仓库的MONGODB配置。在这个简单的应用中我们只用了一个仓库,所以配置也非常的简单:
SecurityConfig(安全配置)
理论上,Spring Security 3.2完全可以使用JavaConfig。但对于我这也仅仅是一个理论,所以这里还是选择xml配置的方式:
使用这个xml就让API能使用基本的安全机制了。
WebAppInitializer(初始化)
我们不想使用web.xml,所以使用下面的代码配置整个应用:
WebAppSecurityInitializer (安全配置初始化)
相对于Spring3,可以使用下面这种更加新颖的特性来完成配置:
WebMvcConfig (Mvc配置)
调度控制器配置。这个也非常简单,仅仅包含了构建一个简单API的最重要配置:
这就是需要的配置,非常简单吧!
IndexController (INDEX控制器)
为了验证这个配置是正确的,我创建了一个IndexController。功能非常简单,只是简单地返回“Hello World”,示例代码如下:
如果运行一下这个应用,就能够在浏览器中看到返回的“Hello World”文本。
构建API
UserService
为了完成Spring安全框架配置,还需要完成另一个部分:实现之前创建的UserService。
构建一个API节点需要处理三个方法:获取当前登陆用户、获取所有用户(可能不是太安全)、创建一个新账户。那么我们就按照这个步骤来进行吧。
Account
Account 将会是我们的第一个Mongo文档。同样也是非常简单:
Repository
先创建一个接口:
接下来创建它的Mongo实现:
API控制器
功能快要完成了。我们需要将内容提供给用户,所以需要创建自己的节点:
我希望你能明白:因为需要直接连接数据库,所以没有对密码进行编码。如果你比较在意这些小细节,那么可以稍后修改。目前这种方式是OK的。
完成
最后我考虑到还需要一个错误处理器,这样用户就可以看到JSON格式的错误信息而不是HTML。使用Spring Mvc以及@ControllerAdvice很容易实现这一点:
如果你想了解关于Spring4 中@ControllerAdvice的用法,请点击以下链接。
测试一下这个app
作为一个单元测试极客,本来应该先创建一个单元测试。但是……这次哥想用用新的工具:Postman(Chrome 插件),所以请往下看我是怎么做的:
获取所有account(非授权)
提交account(无需授权)
获取所有account(已授权)
获取当前account(已授权)
结束语
以上就是所有内容,希望你能像我一样喜欢这种创建项目的方式。创建这个项目以及写这篇文章总共花了我大概三个钟头。其中绝大多数时间是配置安全框架(我希望它在Java中能够更加彻底),以及编写这篇攻略。
原文链接: javacodegeeks 翻译: ImportNew.com - 邬柏
译文链接: http://www.importnew.com/7903.html
[ 转载请保留原文出处、译者和译文链接。]
这是关于使用Spring MVC创建Web API的另一个教程。这并不是一个非常精细的教程,而仅仅是一个演习(攻略)。本教程旨在创建一个提供服务器端API的应用,并且使用Mongo作为它的数据库,使用Spring Security作为安全框架。
准备开始——POM
由于我是一个maven脑残粉,所以这个项目还是基于maven的。现在Spring 4.0 RC2已经发布了,所以我决定使用最新的依赖管理工具。本文使用的pom.xml如下:使用这个配置创建Spring MVC应用确实非常简单。这里面比较新鲜的东西就是dependencyManagement 元素。详解猛戳这儿:http://spring.io/blog/2013/12/03/spring-framework-4-0-rc2-available
配置
这个应用可以使用JavaConfig完成配置。我把它切分为下面几个部分:
ServicesConfig(服务配置)
无需扫描组件,配置真的非常简单:
我们想要一个配置了所有可用仓库的MONGODB配置。在这个简单的应用中我们只用了一个仓库,所以配置也非常的简单:
理论上,Spring Security 3.2完全可以使用JavaConfig。但对于我这也仅仅是一个理论,所以这里还是选择xml配置的方式:
WebAppInitializer(初始化)
我们不想使用web.xml,所以使用下面的代码配置整个应用:
相对于Spring3,可以使用下面这种更加新颖的特性来完成配置:
调度控制器配置。这个也非常简单,仅仅包含了构建一个简单API的最重要配置:
IndexController (INDEX控制器)
为了验证这个配置是正确的,我创建了一个IndexController。功能非常简单,只是简单地返回“Hello World”,示例代码如下:
构建API
UserService
为了完成Spring安全框架配置,还需要完成另一个部分:实现之前创建的UserService。
Account
Account 将会是我们的第一个Mongo文档。同样也是非常简单:
先创建一个接口:
功能快要完成了。我们需要将内容提供给用户,所以需要创建自己的节点:
完成
最后我考虑到还需要一个错误处理器,这样用户就可以看到JSON格式的错误信息而不是HTML。使用Spring Mvc以及@ControllerAdvice很容易实现这一点:
测试一下这个app
作为一个单元测试极客,本来应该先创建一个单元测试。但是……这次哥想用用新的工具:Postman(Chrome 插件),所以请往下看我是怎么做的:
获取所有account(非授权)
提交account(无需授权)
获取所有account(已授权)
获取当前account(已授权)
结束语
以上就是所有内容,希望你能像我一样喜欢这种创建项目的方式。创建这个项目以及写这篇文章总共花了我大概三个钟头。其中绝大多数时间是配置安全框架(我希望它在Java中能够更加彻底),以及编写这篇攻略。
原文链接: javacodegeeks 翻译: ImportNew.com - 邬柏
译文链接: http://www.importnew.com/7903.html
[ 转载请保留原文出处、译者和译文链接。]
相关文章推荐
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API(攻略)
- 如何快速构建基于Spring4.0的Rest API
- 使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【九】——API变了,客户端怎么办?
- 如何更好的设计你的REST API之基于REST架构的Web Service设计及REST框架实现
- 使用ASP.NET Web Api构建基于REST风格的服务实战系列教程【九】——API变了,客户端怎么办?
- SpringBoot + mybatis + Swagger快速构建REST API并生成优美的API文档
- 如何快速构建基于java的微服务
- 使用Spring Boot&Swagger快速构建REST API并生成优美的API文档
- 基于django的rest api快速开发(只提供一个接口服务)
- 构建基于Spring4的Rest API
- ASP.NET WEB API构建基于REST风格
- oracle基于COMMIT SCN的物化视图日志如何支持快速刷新(二)
- 如何构建优雅的Python API
- 云和移动开发风气云涌,Autodesk的一些云应用提供REST API做基于云的二次开发
- 用Maven如何构建一个基于Hibernate Annotation的web项目?