从零开始使用springboot+MongoDB实现restful风格api数据接口

1 环境搭建 1.1 Java下载、安装与配置

下载地址:https://www.oracle.com/java/technologies/downloads/#java8-windows

Step 1 下载与自己系统架构一致的安装包

下载时需要使用Oracle账户登录，没有就注册一个

Step 2 安装

打开安装包后按照默认安装流程安装即可，记住自己选择的安装路径，如我的安装路径是C:Program FilesJava

Step 3 环境变量配置

打开系统环境变量编辑界面
右键单击此电脑>选择属性>点击高级系统设置>点击高级>点击环境变量



后续主要对系统变量窗口进行操作。
新建变量名JAVA_HOME，值填入自己Java的安装路径，如C:Program FilesJavajdk1.8.0_221

新建变量名CLASSPATH，值填入.;%JAVA_HOME%lib;%JAVA_HOME%libtools.jar（注意最前面有一点）。

双击Path–>新建–>添加“%JAVA_HOME%bin”

Step4 测试是否配置成功

win+R弹出运行窗口后，输入cmd

回车弹出命令行窗口，分别输入"java -version"、“javac”

出现如上图所示页面内容，即配置成功。

1.2 Maven下载、安装与配置 Maven的作用

maven主要是用来解决导入java类依赖的jar,编译java项目主要问题。(最早手动导入jar，使用Ant之类的编译java项目)以pom.xml文件中dependency属性管理依赖的jar包，而jar包包含class文件和一些必要的资源文件。当然它可以构建项目，管理依赖，生成一些简单的单元测试报告。比如之前项目导入jar。是通过copy方式导入项目中，而且还会存在jar之间的依赖和冲突。而maven解决了这些问题，只是网速不好的时候有点烦。使用私服nexus解决这个问题。jar 包管理，防止jar之间依赖起冲突 。小组之间建立个私服务，大家都用通用 的maven配置文件，不用自己手动去下载jar ，pom文件会自动管理下载好的jar包。Maven是基于项目对象模型，可以通过一小段描述信息来管理项目的构建，报告和文档的软件项目管理工具。Maven能够很方便的帮你管理项目报告，生成站点，管理jar文件，等等。例如：项目开发中第三方jar引用的问题，开发过程中合作成员引用的jar版本可能不同，还有可能重复引用相同jar的不同版本，使用maven关联jar就可以配置引用jar的版本，避免冲突。

Maven下载

链接：https://pan.baidu.com/s/1wzffJsvdNqo8KJQ0iZ84Fg
提取码：4oor
下载下来的是我已经配置好的3.6版本的Maven环境的压缩包
解压到D:Maven3.6路径即可

1.3 IntelliJ IDEA集成开发环境下载、安装与配置 Step1 官网下载安装包

下载地址：IDEA
一路next，选择安装路径

IDEA社区版安装设置，勾选64位即可

点击Install，等待安装完成

完成/ Finish

Step 2 简单的配置

双击图标，启动 idea，提示配置文件，如下图：选择不导入：Do not import settings.

选择接受协议，continue

选择：Don’t send

选择安装一些插件（可以不选择，直接叉掉）

Step 3 配置Maven

打开IDEA>点击左上角file>点击Setting>点击Build, Execution, Deployment>点击Build Tools>点击Maven


配置User settings file为D:Maven3.6confsettings.xml
配置Local repository为D:Maven3.6repository

3 MongoDB数据库连接查看 3.1 MongoDB Compass下载安装

MongoDB Compass 是MongoDB官方推出的一款GUI工具，用于对MongoDB进行可视化的简单管理。
下载链接：MongoDB Compass

按图中所示进行选择，点击下载msi安装包，依据提示默认安装即可，路径自行选择。

3.2 连接集群MongoDB数据库

本地搭建MongoDB数据库进行测试等过程不再进行详细解释，网上有相关教程，此处仅介绍在实验室集群上已搭建MongoDB数据库的基础上，进行连接查看等操作的具体流程。

Step1 连接集群VPN

该过程略，NAS上有相关文档。

Step 2 配置地址进行连接

打开MongoDB Compass，点击New Connection，点击Fill in connection fields individually

如图所示
Hostname：192.168.100.91
Port：27017
SRV Record：关闭
Authentication：Username/Password
Username：root
Password：123456
Authentication Database：admin

点击Connect进入数据库

Step 3 操作相应表格

可以看到，MongoDB中存储有若干个数据库，在个人进行测试学习时，可在springboot_mongo_db数据库中进行操作，其他数据库较为重要，尽量减少与项目无关的操作。
点击进入springboot_mongo_db数据库。

该数据库中存储有若干个表格，之后springboot中的相关操作主要以user表格为例进行讲解，在个人进行测试学习时，可以尝试自己创建表格进行操作，compass可以做到各种简单或复杂的增删改查操作，支持编写filter语句，详细内容感兴趣的大家可以自行查阅官方文档进行学习。

4 从零开始编写springboot接口

Spring Boot提供了一种新的编程范式，能在最小的阻力下开发Spring应用程序。有了它， 你可以更加敏捷地开发Spring应用程序，专注于应用程序的功能，不用在Spring的配置上多花功 夫，甚至完全不用配置。实际上，Spring Boot的一项重要工作就是让Spring配置不再成为你成功路上的绊脚石。
官方文档

4.1 新建工程

打开IDEA，点击New Project

点击侧边栏Spring Initializer，idea会自动识别Java jdk，选择你安装的版本，starter选择Default即可，点击Next进入下一步。

如图所示
Group:com.bjtu
Artifact:springboot-mongo-demo
Type:Maven
Language:Java
Packaging:Jar
Java version:8
Version:0.0.1-SNAPSHOT
Name:springboot-mongo-demo
Description:Demo project for Spring Boot
Package:com.bjtu.springbootmongodemo
点击Next进入下一步。

配置外部包，工具等。



点击Next进入下一步。
配置项目保存路径，点击Finish创建项目。
进入项目界面后，点击右上角Maven选项卡，点击设置，点击Maven Settings。

参照之前配置maven的流程选择如下两个路径，以自己maven配置的路径为准，然后应用并确定。

4.2 配置pom.xml文件

    4.0.0
    
        org.springframework.boot
        spring-boot-starter-parent
        2.6.2
         
    
    com.bjtu
    springboot-mongo-demo
    0.0.1-SNAPSHOT
    springboot-mongo-demo
    Demo project for Spring Boot
    
        1.8
    
    
        
            org.springframework.boot
            spring-boot-starter-data-mongodb
        
        
            org.springframework.boot
            spring-boot-starter-web
        

        
            org.projectlombok
            lombok
            true
        
        
            org.springframework.boot
            spring-boot-starter-test
            test
        
    

    
        
            
                org.springframework.boot
                spring-boot-maven-plugin
                
                    
                        
                            org.projectlombok
                            lombok
                        
                    
                
            
        
    

4.3 完善目录结构

将SpringbootMongoDemoApplication启动文件移动到bjtu目录下
在bjtu目录下新建以下包
右键bjtu目录>new>package
pojo 存储实体类，Model层
dao 存储基本数据库操作类，进行数据持久化，DAO层
service 存储数据持久化方法的实现类，Service层
controller 存储各种接口的类，Controller层
repository 存储操作MongoDB的模板类
config 存储必要的配置文件
utils 存储各种工具类
项目整体架构如图所示

完整的项目目录结构

4.4 编写接口 Step 1 建立实体类与数据库字段一一对应

package com.bjtu.pojo;

import lombok.*;
import org.springframework.data.annotation.Id;
import org.springframework.data.mongodb.core.index.Indexed;

import javax.validation.constraints.Email;
import javax.validation.constraints.NotNull;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
    @Id
    private String id;

    @NotNull
    private String userName;

    @NotNull
    private String password;

    @NotNull(message = "First Name is mandatory")
    private String firstName;

    @NotNull(message = "Last Name is mandatory")
    private String lastName;

    @NotNull(message = "Email is mandatory")
    @Email(message = "Not valid email")
    @Indexed(unique=true)
    private String email;

    @NotNull(message = "Phone Number is mandatory")
    private String phone;

    private String address;
}

Step 2 建立MongoDB模板，映射MongoDB数据库操作

package com.bjtu.repository;

import com.bjtu.pojo.User;
import org.springframework.data.mongodb.repository.MongoRepository;

public interface UserRepository extends MongoRepository {
    User findByUserName(String userName);
}

详细创建数据库操作方法的说明详见官方文档。

Step 3 编写DAO层，包含基本的crud操作的接口

package com.bjtu.dao;

import com.bjtu.pojo.User;

import java.util.List;


public interface UserDao {
    
    USER getUserByUserName(ID userName) throws Exception;

    List getAllUser();
}

Step 4 编写Service层，实现DAO层接口

package com.bjtu.service;

import com.bjtu.dao.UserDao;
import com.bjtu.pojo.User;
import com.bjtu.repository.UserRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;

@Service
public class UserDaoImpl implements UserDao {

    @Autowired
    private UserRepository userRepository;

    @Override
    public User getUserByUserName(String userName) throws Exception {
        User user = userRepository.findByUserName(userName);
        return user;
    }

    @Override
    public List getAllUser(){
        List users = userRepository.findAll();
        return users;
    }
}

Step 5 编写Controller层，实现restful数据接口

package com.bjtu.controller;

import com.bjtu.pojo.User;
import com.bjtu.service.UserDaoImpl;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import javax.validation.ConstraintViolationException;
import java.util.HashMap;
import java.util.List;
import java.util.Map;


@RestController
@CrossOrigin
public class UserController {

    @Autowired
    private UserDaoImpl registrationImpl;

    @GetMapping("/getUserbyusername" )
    public ResponseEntity getUserByUserName(@RequestParam("userName") String userName) throws Exception {
        User user = registrationImpl.getUserByUserName(userName);
        return new ResponseEntity<>(user, HttpStatus.OK);
    }

    @GetMapping("/getAllUser" )
    public ResponseEntity getAllUser() throws Exception {
        List users = registrationImpl.getAllUser();
        return new ResponseEntity<>(users, HttpStatus.OK);
    }
}

Step 6 修改application.properties配置文件

#MongoDB服务器地址
#spring.data.mongodb.host=localhost
spring.data.mongodb.host=192.168.100.91
#MongoDB服务器端口
spring.data.mongodb.port=27017
#MongoDB身份验证数据库
spring.data.mongodb.authentication-database=admin
#MongoDB服务器用户名
spring.data.mongodb.username=root
#MongoDB服务器密码
spring.data.mongodb.password=123456
#所要操作的MongoDB数据库
spring.data.mongodb.database=springboot_mongo_db
#对外ip，默认localhost
#server.address=192.168.10.2
#对外端口
server.port=8081

Step 7 运行程序，浏览器访问相应接口进行测试

源码地址：https://gitee.com/jack-zxk/springboot-mongo-demo.git