如何：從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擴展程序）。 所以我做了：

獲取帳戶（未授權）：

郵政帳戶（不需要身份驗證：

獲取帳戶（授權）：

獲取當前帳戶（授權）：

我們完了

現在就這樣。 希望您喜歡我喜歡創建該項目。 這個項目和這篇文章總共花了我大約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

總結

以上是生活随笔為你收集整理的如何：从Spring 4.0快速入门以构建简单的REST-Like API（演练）的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。