www.how2j.com_HOW-TO:快速开始使用Spring 4.0,以构建简单的REST-Like API(演练)

www.how2j.com

HOW-TO:快速开始使用Spring 4.0,以构建简单的REST-Like API(演练)

关于使用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配置该应用程序。 我将其分为几个部分:

服务配置

@Configuration
public class ServicesConfig {@Autowiredprivate AccountRepository accountRepository;@Beanpublic UserService userService() {return new UserService(accountRepository);}@Beanpublic PasswordEncoder passwordEncoder() {return NoOpPasswordEncoder.getInstance();}
}

没有组件扫描。 真的很简单。

持久性配置

具有所有可用存储库的MongoDB配置。 在这个简单的应用程序中,我们只有一个存储库,因此配置非常简单。

@Configuration
class PersistenceConfig {@Beanpublic AccountRepository accountRepository() throws UnknownHostException {return new MongoAccountRepository(mongoTemplate());}@Beanpublic MongoDbFactory mongoDbFactory() throws UnknownHostException {return new SimpleMongoDbFactory(new Mongo(), "r");}@Beanpublic MongoTemplate mongoTemplate() throws UnknownHostException {MongoTemplate template = new MongoTemplate(mongoDbFactory(), mongoConverter());return template;}@Beanpublic MongoTypeMapper mongoTypeMapper() {return new DefaultMongoTypeMapper(null);}@Beanpublic MongoMappingContext mongoMappingContext() {return new MongoMappingContext();}@Beanpublic MappingMongoConverter mongoConverter() throws UnknownHostException {MappingMongoConverter converter = new MappingMongoConverter(mongoDbFactory(), mongoMappingContext());converter.setTypeMapper(mongoTypeMapper());return converter;}
}

安全配置

从理论上讲,Spring Security 3.2可以使用JavaConfig进行完全配置。 对我来说,这仍然是一种理论,因此我在这里使用XML:

@Configuration
@ImportResource("classpath:spring-security-context.xml")
public class SecurityConfig {}

XML:如您所见,API将使用基本身份验证。

WebAppInitializer

我们不需要web.xml,因此我们使用以下代码来配置Web应用程序:

@Order(2)
public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {@Overrideprotected String[] getServletMappings() {return new String[]{"/"};}@Overrideprotected Class[] getRootConfigClasses() {return new Class[] {ServicesConfig.class, PersistenceConfig.class, SecurityConfig.class};}@Overrideprotected Class[] getServletConfigClasses() {return new Class[] {WebMvcConfig.class};}@Overrideprotected Filter[] getServletFilters() {CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter();characterEncodingFilter.setEncoding("UTF-8");characterEncodingFilter.setForceEncoding(true);return new Filter[] {characterEncodingFilter};}@Overrideprotected void customizeRegistration(ServletRegistration.Dynamic registration) {        registration.setInitParameter("spring.profiles.active", "default");}
}

WebAppSecurityInitializer

Spring Security的新功能3。

@Order(1)
public class WebAppSecurityInitializer extends AbstractSecurityWebApplicationInitializer {}

WebMvcConfig

调度程序Servlet配置。 真的很基础。 只有关键组件才能构建简单的API。

@Configuration
@ComponentScan(basePackages = { "pl.codeleak.r" }, includeFilters = {@Filter(value = Controller.class)})
public class WebMvcConfig extends WebMvcConfigurationSupport {private static final String MESSAGE_SOURCE = "/WEB-INF/i18n/messages";@Overridepublic RequestMappingHandlerMapping requestMappingHandlerMapping() {RequestMappingHandlerMapping requestMappingHandlerMapping = super.requestMappingHandlerMapping();requestMappingHandlerMapping.setUseSuffixPatternMatch(false);requestMappingHandlerMapping.setUseTrailingSlashMatch(false);return requestMappingHandlerMapping;}@Bean(name = "messageSource")public MessageSource messageSource() {ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();messageSource.setBasename(MESSAGE_SOURCE);messageSource.setCacheSeconds(5);return messageSource;}@Overridepublic Validator getValidator() {LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean();validator.setValidationMessageSource(messageSource());return validator;}@Overridepublic void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {configurer.enable();}
}

这就是配置。 简单。

索引控制器

为了验证配置是否正确,我创建了一个IndexController,它提供简单的“ Hello,World”之类的文本:

@Controller
@RequestMapping("/")
public class IndexController {@RequestMapping@ResponseBodypublic String index() {return "This is an API endpoint.";}
}

运行应用程序时,您应该在浏览器中看到此文本。

构建API

用户服务

要完成Spring Security配置,实际上实际上仍然需要一部分:UserService之前创建的实例:

public class UserService implements UserDetailsService {private AccountRepository accountRepository;public UserService(AccountRepository accountRepository) {this.accountRepository = accountRepository;}@Overridepublic UserDetails loadUserByUsername(String username) throws UsernameNotFoundException {Account account = accountRepository.findByEmail(username);if(account == null) {throw new UsernameNotFoundException("user not found");}return createUser(account);}public void signin(Account account) {SecurityContextHolder.getContext().setAuthentication(authenticate(account));}private Authentication authenticate(Account account) {return new UsernamePasswordAuthenticationToken(createUser(account), null, Collections.singleton(createAuthority(account)));  }private User createUser(Account account) {return new User(account.getEmail(), account.getPassword(), Collections.singleton(createAuthority(account)));}private GrantedAuthority createAuthority(Account account) {return new SimpleGrantedAuthority(account.getRole());}}

要求是构建一个处理3种方法的API端点:获取当前登录的用户,获取所有用户(不是很安全),创建新帐户。 所以做吧。

帐户

该帐户将是我们的第一个Mongo文档。 这真的很容易:

@SuppressWarnings("serial")
@Document
public class Account implements java.io.Serializable {@Idprivate String objectId;@Email@Indexed(unique = true)private String email;@JsonIgnore@NotBlankprivate String password;private String role = "ROLE_USER";private Account() {}public Account(String email, String password, String role) {this.email = email;this.password = password;this.role = role;}// getters and setters
}

资料库

我从界面开始:

public interface AccountRepository {Account save(Account account);List findAll();Account findByEmail(String email);
}

以及后来的Mongo实现:

public class MongoAccountRepository implements AccountRepository {private MongoTemplate mongoTemplate;public MongoAccountRepository(MongoTemplate mongoTemplate) {this.mongoTemplate = mongoTemplate;}@Overridepublic Account save(Account account) {mongoTemplate.save(account);return account;}@Overridepublic List findAll() {return mongoTemplate.findAll(Account.class);}@Overridepublic Account findByEmail(String email) {return mongoTemplate.findOne(Query.query(Criteria.where("email").is(email)), Account.class);}
}

API控制器

所以我们快到了。 我们需要将内容提供给用户。 因此,让我们创建端点:

@Controller
@RequestMapping("api/account")
class AccountController {private AccountRepository accountRepository;@Autowiredpublic AccountController(AccountRepository accountRepository) {this.accountRepository = accountRepository;}@RequestMapping(value = "current", method = RequestMethod.GET)@ResponseStatus(value = HttpStatus.OK)@ResponseBody@PreAuthorize(value = "isAuthenticated()")public Account current(Principal principal) {Assert.notNull(principal);return accountRepository.findByEmail(principal.getName());}@RequestMapping(method = RequestMethod.GET)@ResponseStatus(value = HttpStatus.OK)@ResponseBody@PreAuthorize(value = "isAuthenticated()")public Accounts list() {List accounts = accountRepository.findAll();return new Accounts(accounts);}@RequestMapping(method = RequestMethod.POST)@ResponseStatus(value = HttpStatus.CREATED)@ResponseBody@PreAuthorize(value = "permitAll()")public Account create(@Valid Account account) {accountRepository.save(account);return account;}private class Accounts extends ArrayList {public Accounts(List accounts) {super(accounts);}}
}

希望您注意到我们直接与存储库进行通讯,因此不会对密码进行编码。 如果需要,可以稍后修复一些小细节。 现在可以了。

整理起来

我最后需要的是一些错误处理程序,以便使用者可以使用JSON而不是HTML看到错误消息。 使用Spring MVC和@Controller建议,这很简单。

@ControllerAdvice
public class ErrorHandler {@ExceptionHandler(value = Exception.class)@ResponseStatus(HttpStatus.BAD_REQUEST)@ResponseBodypublic ErrorResponse errorResponse(Exception exception) {return new ErrorResponse(exception.getMessage());}}public class ErrorResponse {private String message;public ErrorResponse(String message) {this.message = message;}public String getMessage() {return message;}
}

如果您想在Spring 4中看到@ControllerAdvice的更多高级用法,请阅读
这个帖子 。

测试应用

作为一个单元测试极客,我应该首先创建单元测试。 但是……我只是想测试一个新工具:Postman(Chrome扩展程序)。 所以我做了:

获取帐户(未授权):

gna1

邮政帐户(不需要身份验证:

gna2

获取帐户(授权):

gna3

获取当前帐户(授权):

gna4

我们完了

现在就这样。 希望您喜欢我喜欢创建该项目。 这个项目和这篇文章总共花了我大约3个小时。 我大部分时间都花在弄清楚安全性配置上(我希望它完全使用Java)并编写此演练。

参考:操作方法:从我们的JCG合作伙伴 Rafal Borowiec在Codeleak.pl博客上快速开始于Spring 4.0,以构建一个简单的REST-Like API(演练) 。

翻译自: https://www.javacodegeeks.com/2013/12/how-to-get-started-quickly-with-spring-4-0-to-build-a-simple-rest-like-api-walkthrough.html

www.how2j.com

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/345177.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【渝粤题库】国家开放大学2021春3938管理英语2题目

试卷代号:3938 2 0 2 1年春季学期期末统一考试 管理英语2 试题 2021年7月 注 意 事 项 一、将你的学号、姓名及分校(工作站)名称填写在答题纸的规定栏内。考试结束后,把试卷和答题纸放在桌上。试卷和答题纸均不得带出考场。监考人…

flutter 返回指定界面_Flutter页面路由导航及传参

转载请注明出处: https://learnandfish.com/概述 每个应用都有很多个页面,在flutter中同样也有很多页面,被称之为路由(Router),页面之间的跳转通过导航器(Navigator)进行管理。其中 Navigator.push 和 Navigator.pop 是最简单的跳转到新页面和…

正确的工作流程:我应该使用哪个OAuth 2.0流程?

什么是OAuth 2.0 OAuth 2.0是一个已被广泛采用的委托授权框架,已经存在了很多年,并且似乎已经存在。 如果您不熟悉OAuth 2.0的基本概念,可以使用 川崎孝彦写的优秀文章 。 这只是OAuth 2.0各方的简要提醒: 资源所有者–受保护资…

【渝粤题库】广东开放大学 秘书实务21 形成性考核

👉关注我,看答案👈 选择题 题目: 秘书职能包括以下哪几项? 选择一项或多项: 题目: 秘书职能包括以下哪几项? 选择一项或多项: 题目: 下列不属于企业文化的功能是&#…

mysql workbench入门_5分钟入门MySQL Workbench

接下来进入下一步,使用Workbench执行sql文件:1.打开Workbench,主页面上点击要connect的连接。2.注意系统偏好设置里,MySQL是running的状态,否则无法执行。创建数据库:点击创建数据库按钮,输入数…

【渝粤题库】广东开放大学 形成性考核 - 副本 (17)

选择题 题目:产值中心论关心的焦点是( ) 题目:要求企业“以产品为中心”的业务模式向“客户为中心”的模式转变,这是客户关系管理的( ) 题目:客户关系管理系统需要建立数据仓库…

【渝粤题库】广东开放大学 文化投资与贸易 形成性考核

选择题 题目:文化产业的最大价值在于()的规模效应。 题目:文化企业指那些在文化产业环境下以创意、生产、交换、()文化产品为方式、以期获得商业利润为目的的工商组织。 题目:由文化产业的内涵可…

apache +php + mysql_apache+php+mysql

apachephpmysqlimapldapjdktomcat的安装以下过程在redhat6.2 7.0下通过。使用软件:apache_1.3.19.tar.gzimap-2000c.tar.Zmod_jserv.so..soj2sdk-1_3_0_02-linux.binmysql-3.23.33-pc-linux-gnu-i6862.tar.gzopenldap-2.0.7.tar.gzphp-4.0.4pl1.tar.gzjakarta-tomca…

【渝粤题库】广东开放大学 个人与团队管理 形成性考核

题库查询系统 选择题 题目: 按照KOLB学习周期,一个完整的学习过程包含四个阶段,不属于这四个阶段的是( )。 A、获得经验 B、反思 C、认真分析 D、理论化和应用 选择一项&#xf…

使用Spring Boot和Vue进行有益的开发

“我喜欢编写身份验证和授权代码。” 〜从来没有Java开发人员。 厌倦了一次又一次地建立相同的登录屏幕? 尝试使用Okta API进行托管身份验证,授权和多因素身份验证。 Vue是一个Web框架,由于它的精简和刻薄,最近引起了很多关注。 …

effective mysql之备份与恢复_Effective MySQL之备份与恢复

第1章五分钟成为一名DBA1.1MySQL备份1.1.1确定数据库的大小1.1.2选择锁策略1.1.3运行时间1.1.4组合信息1.2执行MySQL备份1.2.1运行mysqldump1.2.2安全地备份1.2.3使用mysqldump的好处1.2.4更多信息1.2.5其他选项1.3本章小结第2章理解备份选项第1章五分钟成为一名DBA1.1MySQL备份…

mysql mydumper_系统运维|Mydumper-MySQL数据库备份工具

Mydumper 是 MySQL 数据库服务器备份工具,它比 MySQL 自带的 mysqldump 快很多。它还有在转储的同时获取远程服务器二进制日志文件的能力。Mydumper 的优势并行能力 (因此有高速度) 和性能 (高效的代码避免了耗费 CPU 处理能力的字符集转换过程)更容易管理输出 (每个…

【渝粤题库】广东开放大学 文化传播学 形成性考核

选择题 题目:从人类生活(特别是人类精神生活)的内容与内涵的角度对“文化”界定为:从最为广泛的民族志的意义上看,文化或文明是一个综合性体系,它包括知识、信仰、艺术、道德、法、习俗及作为社会成员的人所…

在日志中搜索时间间隔

介绍 这篇文章与我有关日志分析的迷你系列文章间接相关。 最好阅读两个主要部分,以更好地理解我在说什么。 第1 部分 , 第2部分 。 这篇文章描述了我在实现IDE方法时遇到的一个重要问题。 任务描述 当某人使用日志时,通常只需要调查一个时间…

【渝粤题库】广东开放大学 民事诉讼法 形成性考核

选择题 题目:人民法院认定公民无行为能力的判决作出以后,该公民经过治疗,病情得到好转,逐渐又恢复了民事行为能力。对此种情况,人民法院根据利害关系人的申请,应当如何处理?( &#…

mysql names gb2312_mysql_query(set names gb2312)设置客户端字符集

$connmysql_connect("localhost","root","123456");mysql_select_db("db_bcty365",$conn);mysql_query("set names gb2312");?>其中:SET NAMES ‘x‘语句与这三个语句等价:mysql> SET charact…

【渝粤题库】广东开放大学 系统工程 形成性考核

​👉关注我,看答案👈 选择题 题目:自组织是( )因素相互作用的结果,是复杂系统追求的目标。 题目:系统科学体系中,应当区分基础科学与技术科学。例如,基础科学包括运筹学、信息论、控制论等。 题…

【渝粤题库】广东开放大学 计算机网络 形成性考核

选择题 题目:随着微型计算机的广泛应用,大量的微型计算机是通过局域网连入广域网,而局域网域广域网的互连是通过 实现的。 题目:网络是分布在不同地理位置的多个独立的 的集合。 题目:在OSI参考模型中,在网…

php加mySQL制作网络硬盘_PHP实现的简单网络硬盘

/p>"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">disk online.font {font-family: Consolas;color: #369;font-size: 12px;}.box {font-family: Consolas;font-size: 13px;color: #369;border: 1px solid #000;}.btn {font-family: "微软雅…

vue调用手机相机相册_详解Vue调用手机相机和相册以及上传

组件选中{{imgList.length}}张文件,共{{bytesToSize(this.size)}}javaScript代码export default {name: "cameras-and-albums",data(){return{imgList: [],datas: new FormData(),files:0,size:0}},methods:{//调用相册&相机fileClick() {$(#upload_f…