HOW-TO: Get started quickly with Spring 4.0 to build a simple REST-Like API (wal-优快云博客

本文介绍如何使用Spring 4快速构建简单的RESTful API。通过实例演示了配置、安全性和控制器等关键部分，包括Java配置、MongoDB集成及Spring Security的应用。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

HOW-TO: Get started quickly with Spring 4.0 to build a simple REST-Like API (walkthrough)

Yet another tutorial about creating Web API with Spring MVC. Not really sophisticated. Just a walkthrough. The resulting app will serve simple API, will use Mongo as its persistence and it will be secured with Spring Security.

Getting started – POM

Of course, I am still a huge fan of Maven so the project is Maven based. Since there is Spring 4.0 RC2 available, I decided to utilize its new dependency managament which results in the following pom.xml: It is quite simple as it goes to Spring MVC application. The new thing is thedependencyManagement element. More explanation on that can be found here: http://spring.io/blog/2013/12/03/spring-framework-4-0-rc2-available

Configuration

The application is configured using JavaConfig. I divided it into several parts:

ServicesConfig

 
    01@Configuration

    02 public class ServicesConfig { 

    03 

    04     @Autowired 

    05     private AccountRepository accountRepository; 

    06 

    07     @Bean 

    08     public UserService userService() { 

    09         return new UserService(accountRepository); 

    10     } 

    11 

    12     @Bean 

    13     public PasswordEncoder passwordEncoder() { 

    14         return NoOpPasswordEncoder.getInstance(); 

    15     } 

    16}

No component scan. Really simple.

PersistenceConfig

A MongoDB configuration with all available repositories. In this simple application we have only one repository, so the configuration is really simple.

 
    01@Configuration

class PersistenceConfig { 

    03 

    @Bean 

    public AccountRepository accountRepository() throws UnknownHostException { 

        return new MongoAccountRepository(mongoTemplate()); 

    } 

    08 

    @Bean 

    public MongoDbFactory mongoDbFactory() throws UnknownHostException { 

        return new SimpleMongoDbFactory(new Mongo(), "r"); 

    } 

    13 

    @Bean 

    public MongoTemplate mongoTemplate() throws UnknownHostException { 

        MongoTemplate template = new MongoTemplate(mongoDbFactory(), mongoConverter()); 

        return template; 

    } 

    19 

    @Bean 

    public MongoTypeMapper mongoTypeMapper() { 

        return new DefaultMongoTypeMapper(null); 

    } 

    24 

    @Bean 

    public MongoMappingContext mongoMappingContext() { 

        return new MongoMappingContext(); 

    } 

    29 

    @Bean 

    public MappingMongoConverter mongoConverter() throws UnknownHostException { 

        MappingMongoConverter converter = new MappingMongoConverter(mongoDbFactory(), mongoMappingContext()); 

        converter.setTypeMapper(mongoTypeMapper()); 

        return converter; 

    } 

    36}

SecurityConfig

In theory, Spring Security 3.2 can be fully configured with JavaConfig. For me it is still a theory, so I use XML here:

 
    1@Configuration

    2 @ImportResource("classpath:spring-security-context.xml") 

    3 public class SecurityConfig {}

And the XML: As you can see basic authentication will be used for the API.

WebAppInitializer

We don’t want the web.xml so we use the following code to configure the web application:

 
@Order(2) 

public class WebAppInitializer extends AbstractAnnotationConfigDispatcherServletInitializer { 

    03 

    @Override 

    protected String[] getServletMappings() { 

        return new String[]{"/"}; 

    } 

    08 

    @Override 

    protected Class[] getRootConfigClasses() { 

        return new Class[] {ServicesConfig.class, PersistenceConfig.class, SecurityConfig.class}; 

    } 

    13 

    @Override 

    protected Class[] getServletConfigClasses() { 

        return new Class[] {WebMvcConfig.class}; 

    } 

    18 

    @Override 

    protected Filter[] getServletFilters() { 

        CharacterEncodingFilter characterEncodingFilter = new CharacterEncodingFilter(); 

        characterEncodingFilter.setEncoding("UTF-8"); 

        characterEncodingFilter.setForceEncoding(true); 

        return new Filter[] {characterEncodingFilter}; 

    } 

    26 

    @Override 

    protected void customizeRegistration(ServletRegistration.Dynamic registration) {        

        registration.setInitParameter("spring.profiles.active", "default"); 

    } 

    31}

WebAppSecurityInitializer

New to Spring Security 3.

 
    1 @Order(1) 

    2 public class WebAppSecurityInitializer extends AbstractSecurityWebApplicationInitializer { 

    3 

    4}

WebMvcConfig

The dispatcher servlet configuration. Really basic. Only crucial components to build a simple API.

 
    01@Configuration

@ComponentScan(basePackages = { "pl.codeleak.r" }, includeFilters = {@Filter(value = Controller.class)}) 

public class WebMvcConfig extends WebMvcConfigurationSupport { 

    04 

    private static final String MESSAGE_SOURCE = "/WEB-INF/i18n/messages"; 

    06 

    @Override 

    public RequestMappingHandlerMapping requestMappingHandlerMapping() { 

        RequestMappingHandlerMapping requestMappingHandlerMapping =super.requestMappingHandlerMapping(); 

        requestMappingHandlerMapping.setUseSuffixPatternMatch(false); 

        requestMappingHandlerMapping.setUseTrailingSlashMatch(false); 

        return requestMappingHandlerMapping; 

    } 

    14 

    @Bean(name = "messageSource") 

    public MessageSource messageSource() { 

        ReloadableResourceBundleMessageSource messageSource = newReloadableResourceBundleMessageSource(); 

        messageSource.setBasename(MESSAGE_SOURCE); 

        messageSource.setCacheSeconds(5); 

        return messageSource; 

    } 

    22 

    @Override 

    public Validator getValidator() { 

        LocalValidatorFactoryBean validator = new LocalValidatorFactoryBean(); 

        validator.setValidationMessageSource(messageSource()); 

        return validator; 

    } 

    29 

    @Override 

    public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) { 

        configurer.enable(); 

    } 

    34}

And that’s the config. Simple.

IndexController

To verify the config is fine, I created an IndexController, that serves simple “Hello, World” like text:

 
    01@Controller

@RequestMapping("/") 

public class IndexController { 

    04 

    @RequestMapping 

    @ResponseBody 

    public String index() { 

        return "This is an API endpoint."; 

    } 

    10}

As you run the application, you should see this text in the browser.

Building the API

UserService

To finish up with the Spring Security configuration, one part is actually still needed: UserService which instance was created earlier:

 
public class UserService implements UserDetailsService { 

    02 

    private AccountRepository accountRepository; 

    04 

    public UserService(AccountRepository accountRepository) { 

        this.accountRepository = accountRepository; 

    } 

    08 

 @Override 

 public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { 

  Account account = accountRepository.findByEmail(username); 

  if(account == null) { 

   throw new UsernameNotFoundException("user not found"); 

  } 

  return createUser(account); 

 } 

    17 

 public void signin(Account account) { 

  SecurityContextHolder.getContext().setAuthentication(authenticate(account)); 

 } 

    21 

 private Authentication authenticate(Account account) { 

  return new UsernamePasswordAuthenticationToken(createUser(account), null, Collections.singleton(createAuthority(account)));  

 } 

    25 

 private User createUser(Account account) { 

  return new User(account.getEmail(), account.getPassword(), Collections.singleton(createAuthority(account))); 

 } 

    29 

 private GrantedAuthority createAuthority(Account account) { 

  return new SimpleGrantedAuthority(account.getRole()); 

 } 

    33 

    34}

The requirement was to build an API endpoint that handles 3 methods: gets currently logged in user, gets all users (not really safe), creates a new account. So let’s do it.

Account

Account will be our first Mongo document. It is really easy one:

 
    01 @SuppressWarnings("serial") 

    02@Document

    03 public class Account implements java.io.Serializable { 

    04 

    05     @Id 

    06     private String objectId; 

    07 

    08     @Email 

    09     @Indexed(unique = true) 

    10     private String email; 

    11 

    12     @JsonIgnore 

    13     @NotBlank 

    14     private String password; 

    15 

    16     private String role = "ROLE_USER"; 

    17 

    18     private Account() { 

    19 

    20     } 

    21 

    22     public Account(String email, String password, String role) { 

    23         this.email = email; 

    24         this.password = password; 

    25         this.role = role; 

    26     } 

    27 

    28    // getters and setters 

    29}

Repository

I started with the interface:

 
    1 public interface AccountRepository { 

    2 

    3     Account save(Account account); 

    4 

    5     List findAll(); 

    6 

    7     Account findByEmail(String email); 

    8}

And later with its Mongo implementation:

 
public class MongoAccountRepository implements AccountRepository { 

    02 

    private MongoTemplate mongoTemplate; 

    04 

    public MongoAccountRepository(MongoTemplate mongoTemplate) { 

        this.mongoTemplate = mongoTemplate; 

    } 

    08 

    @Override 

    public Account save(Account account) { 

        mongoTemplate.save(account); 

        return account; 

    } 

    14 

    @Override 

    public List findAll() { 

        return mongoTemplate.findAll(Account.class); 

    } 

    19 

    @Override 

    public Account findByEmail(String email) { 

        return mongoTemplate.findOne(Query.query(Criteria.where("email").is(email)), Account.class); 

    } 

    24}

API Controller

So we are almost there. We need to serve the content to the user. So let’s create our endpoint:

 
    01@Controller

@RequestMapping("api/account") 

class AccountController { 

    04 

    private AccountRepository accountRepository; 

    06 

    @Autowired 

    public AccountController(AccountRepository accountRepository) { 

        this.accountRepository = accountRepository; 

    } 

    11 

    @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()); 

    } 

    20 

    @RequestMapping(method = RequestMethod.GET) 

    @ResponseStatus(value = HttpStatus.OK) 

    @ResponseBody 

    @PreAuthorize(value = "isAuthenticated()") 

    public Accounts list() { 

        List accounts = accountRepository.findAll(); 

        return new Accounts(accounts); 

    } 

    29 

    @RequestMapping(method = RequestMethod.POST) 

    @ResponseStatus(value = HttpStatus.CREATED) 

    @ResponseBody 

    @PreAuthorize(value = "permitAll()") 

    public Account create(@Valid Account account) { 

        accountRepository.save(account); 

        return account; 

    } 

    38 

    private class Accounts extends ArrayList { 

        public Accounts(List accounts) { 

            super(accounts); 

        } 

    } 

    44}

I hope you noticed that we talk directly to the repository, so the passwords will not be encoded. Small detail to be fixed later on, if you wish. For now it is OK.

Finishing up

The last think I needed was some error handler so the consumer can see error messages in JSON instead of HTML. This is simple with Spring MVC and @Controller advice.

 
    01@ControllerAdvice

public class ErrorHandler { 

    03 

    @ExceptionHandler(value = Exception.class) 

    @ResponseStatus(HttpStatus.BAD_REQUEST) 

    @ResponseBody 

    public ErrorResponse errorResponse(Exception exception) { 

        return new ErrorResponse(exception.getMessage()); 

    } 

    10 

    11}

    12 

public class ErrorResponse { 

    private String message; 

    public ErrorResponse(String message) { 

        this.message = message; 

    } 

    public String getMessage() { 

        return message; 

    } 

    21}

If you want to see more advance usage of @ControllerAdvice in Spring 4 read
this post.

Testing the app

As a unit test geek I should have created Unit Tests first. But… I just wanted to test a new tool: Postman (Chrome extension). So I did:

Get accounts (not authorized):

Post account (does not require authentication:

Get accounts (authorized):

Get current account (authorized):

We are done

That’s it for now. Hope you enjoyed as I enjoyed creating the project. The project and this post took me about ~3h in overall. Most of the time I spent on figuring out the security configuration (I wanted it to be fully in Java) and writing this walkthrough.