社区阿杜:Restful Spring Boot with MongoDB

Posted SpringForAll社区

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了社区阿杜:Restful Spring Boot with MongoDB相关的知识,希望对你有一定的参考价值。

为什么是mongodb?

继续之前的dailyReport项目,今天的任务是选择mongogdb作为持久化存储。

关于nosql和rdbms的对比以及选择,我参考了不少资料,关键一点在于:nosql可以轻易扩展表的列,对于业务快速变化的应用场景非常适合;rdbms则需要安装关系型数据库模式对业务进行建模,适合业务场景已经成熟的系统。我目前的这个项目——dailyReport,我暂时没法确定的是,对于一个report,它的属性应该有哪些:date、title、content、address、images等等,基于此我选择mongodb作为该项目的持久化存储。

如何将mongodb与spring boot结合使用

  • 修改Pom文件,增加mongodb支持

 
   
   
 
  1. <dependency>

  2.  <groupId>org.springframework.boot</groupId>

  3.  <artifactId>spring-boot-starter-data-mongodb</artifactId>

  4. </dependency>

  • 重新设计Report实体类,id属性是给mongodb用的,用@Id注解修饰;重载toString函数,使用String.format输出该对象。

 
   
   
 
  1. import org.springframework.data.annotation.Id;

  2. /**

  3. * @author duqi

  4. * @create 2015-11-17 19:31

  5. */

  6. public class Report {

  7.    @Id

  8.    private String id;

  9.    private String date;

  10.    private String content;

  11.    private String title;

  12.    public Report() {

  13.    }

  14.    public Report(String date, String title, String content) {

  15.        this.date = date;

  16.        this.title = title;

  17.        this.content = content;

  18.    }

  19.    public String getId() {

  20.        return id;

  21.    }

  22.    public void setId(String id) {

  23.        this.id = id;

  24.    }

  25.    public String getTitle() {

  26.        return title;

  27.    }

  28.    public void setTitle(String title) {

  29.        this.title = title;

  30.    }

  31.    public String getDate() {

  32.        return date;

  33.    }

  34.    public void setDate(String dateStr) {

  35.        this.date = dateStr;

  36.    }

  37.    public String getContent() {

  38.        return content;

  39.    }

  40.    public void setContent(String content) {

  41.        this.content = content;

  42.    }

  43.    @Override

  44.    public String toString() {

  45.        return String.format("Report[id=%s, date='%s', content='%s', title='%s']", id, date, content, title);

  46.    }

  47. }

  • 增加ReportRepository接口,它继承自MongoRepository接口,MongoRepository接口包含了常用的CRUD操作,例如:save、insert、findall等等。我们可以定义自己的查找接口,例如根据report的title搜索,具体的ReportRepository接口代码如下:

 
   
   
 
  1. import org.springframework.data.mongodb.repository.MongoRepository;

  2. import java.util.List;

  3. /**

  4. * Created by duqi on 15/11/22.

  5. */

  6. public interface ReportRepository extends MongoRepository<Report, String> {

  7.    Report findByTitle(String title);

  8.    List<Report> findByDate(String date);

  9. }

  • 修改ReportService代码,增加createReport函数,该函数根据Conroller传来的Map参数初始化一个Report对象,并调用ReportRepository将数据save到mongodb中;对于getReportDetails函数,仍然开启缓存,如果没有缓存的时候则利用findByTitle接口查询mongodb数据库。

 
   
   
 
  1. import com.javadu.dailyReport.domain.Report;

  2. import com.javadu.dailyReport.domain.ReportRepository;

  3. import org.springframework.beans.factory.annotation.Autowired;

  4. import org.springframework.cache.annotation.Cacheable;

  5. import org.springframework.stereotype.Service;

  6. import java.util.Map;

  7. /**

  8. * @author duqi

  9. * @create 2015-11-17 20:05

  10. */

  11. @Service

  12. public class ReportService {

  13.    @Autowired

  14.    private ReportRepository repository;

  15.    public Report createReport(Map<String, Object> reportMap) {

  16.        Report report = new Report(reportMap.get("date").toString(),

  17.                reportMap.get("title").toString(),

  18.                reportMap.get("content").toString());

  19.        repository.save(report);

  20.        return report;

  21.    }

  22.    @Cacheable(value = "reportcache", keyGenerator = "wiselyKeyGenerator")

  23.    public Report getReportDetails(String title) {

  24.        System.out.println("无缓存的时候调用这里---数据库查询, title=" + title);

  25.        return repository.findByTitle(title);

  26.    }

  27. }

Restful接口

Controller只负责URL到具体Service的映射,而在Service层进行真正的业务逻辑处理,我们这里的业务逻辑异常简单,因此显得Service层可有可无,但是如果业务逻辑复杂起来(比方说要通过RPC调用一个异地服务),这些操作都需要再service层完成。总体来讲,Controller层只负责:转发请求 + 构造Response数据;在需要进行权限验证的时候,也在Controller层利用aop完成。

一般将对于Report(某个实体)的所有操作放在一个Controller中,并用@RestController和@RequestMapping("/report")注解修饰,表示所有xxxx/report开头的URL会由这个ReportController进行处理。

. POST

对于增加report操作,我们选择POST方法,并使用@RequestBody修饰POST请求的请求体,也就是createReport函数的参数;

. GET

对于查询report操作,我们选择GET方法,URL的形式是:“xxx/report/${report's title}”,使用@PathVariable修饰url输入的参数,即title。

 
   
   
 
  1. import com.javadu.dailyReport.domain.Report;

  2. import com.javadu.dailyReport.service.ReportService;

  3. import org.slf4j.Logger;

  4. import org.slf4j.LoggerFactory;

  5. import org.springframework.beans.factory.annotation.Autowired;

  6. import org.springframework.web.bind.annotation.*;

  7. import java.util.LinkedHashMap;

  8. import java.util.Map;

  9. /**

  10. * @author duqi

  11. * @create 2015-11-17 20:10

  12. */

  13. @RestController

  14. @RequestMapping("/report")

  15. public class ReportController {

  16.    private static final Logger logger = LoggerFactory.getLogger(ReportController.class);

  17.    @Autowired

  18.    ReportService reportService;

  19.    @RequestMapping(method = RequestMethod.POST)

  20.    public Map<String, Object> createReport(@RequestBody Map<String, Object> reportMap) {

  21.        logger.info("createReport");

  22.        Report report = reportService.createReport(reportMap);

  23.        Map<String, Object> response = new LinkedHashMap<String, Object>();

  24.        response.put("message", "Report created successfully");

  25.        response.put("report", report);

  26.        return response;

  27.    }

  28.    @RequestMapping(method = RequestMethod.GET, value = "/{reportTitle}")

  29.    public Report getReportDetails(@PathVariable("reportTitle") String title) {

  30.        logger.info("getReportDetails");

  31.        return reportService.getReportDetails(title);

  32.    }

  33. }

Update和delete操作我这里就不一一讲述了,留个读者作为练习

参考资料

  1. sql vs nosql: what you need to know

  2. Accessing data with Mongodb

  3. Spring Boot:Restful API using Spring Boot and Mongodb


感谢


http://www.jianshu.com/u/28d7875c78df


推荐:

上一篇:




最好的赞赏

就是你的关注


以上是关于社区阿杜:Restful Spring Boot with MongoDB的主要内容,如果未能解决你的问题,请参考以下文章

Spring Boot 实现 RESTful

Spring Boot + Spring Security Restful 登录

Spring+Spring Boot+Mybatis框架注解解析

spring boot:使接口返回统一的RESTful格式数据(spring boot 2.3.1)

Spring Boot 中 10 行代码构建 RESTful 风格应用

spring-boot restful put方式提交表单