• 售前

  • 售后

热门帖子
入门百科

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

[复制链接]
浪漫无边际缺 显示全部楼层 发表于 2022-1-12 20:49:35 |阅读模式 打印 上一主题 下一主题
1 环境搭建

1.1 Java下载、安装与配置

下载地址:https://www.oracle.com/java/technologies/downloads/#java8-windows
Step 1 下载与自己系统架构一致的安装包


下载时需要使用Oracle账户登录,没有就注册一个
Step 2 安装

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

Step 3 环境变量配置

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



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

新建变量名CLASSPATH,值填入.;%JAVA_HOME%\lib;%JAVA_HOME%\lib\tools.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.6\conf\settings.xml
配置Local repository为D:\Maven3.6\repository
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文件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  4.     <modelVersion>4.0.0</modelVersion>
  5.     <parent>
  6.         <groupId>org.springframework.boot</groupId>
  7.         <artifactId>spring-boot-starter-parent</artifactId>
  8.         <version>2.6.2</version>
  9.         <relativePath/> <!-- lookup parent from repository -->
  10.     </parent>
  11.     <groupId>com.bjtu</groupId>
  12.     <artifactId>springboot-mongo-demo</artifactId>
  13.     <version>0.0.1-SNAPSHOT</version>
  14.     <name>springboot-mongo-demo</name>
  15.     <description>Demo project for Spring Boot</description>
  16.     <properties>
  17.         <java.version>1.8</java.version>
  18.     </properties>
  19.     <dependencies>
  20.         <dependency>
  21.             <groupId>org.springframework.boot</groupId>
  22.             <artifactId>spring-boot-starter-data-mongodb</artifactId>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.springframework.boot</groupId>
  26.             <artifactId>spring-boot-starter-web</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>org.projectlombok</groupId>
  30.             <artifactId>lombok</artifactId>
  31.             <optional>true</optional>
  32.         </dependency>
  33.         <dependency>
  34.             <groupId>org.springframework.boot</groupId>
  35.             <artifactId>spring-boot-starter-test</artifactId>
  36.             <scope>test</scope>
  37.         </dependency>
  38.     </dependencies>
  39.     <build>
  40.         <plugins>
  41.             <plugin>
  42.                 <groupId>org.springframework.boot</groupId>
  43.                 <artifactId>spring-boot-maven-plugin</artifactId>
  44.                 <configuration>
  45.                     <excludes>
  46.                         <exclude>
  47.                             <groupId>org.projectlombok</groupId>
  48.                             <artifactId>lombok</artifactId>
  49.                         </exclude>
  50.                     </excludes>
  51.                 </configuration>
  52.             </plugin>
  53.         </plugins>
  54.     </build>
  55. </project>
复制代码
4.3 完善目录结构

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

完整的项目目录结构

4.4 编写接口

Step 1 建立实体类与数据库字段一一对应

  1. package com.bjtu.pojo;
  2. import lombok.*;
  3. import org.springframework.data.annotation.Id;
  4. import org.springframework.data.mongodb.core.index.Indexed;
  5. import javax.validation.constraints.Email;
  6. import javax.validation.constraints.NotNull;
  7. @Data
  8. @AllArgsConstructor
  9. @NoArgsConstructor
  10. public class User {
  11.     @Id
  12.     private String id;
  13.     @NotNull
  14.     private String userName;
  15.     @NotNull
  16.     private String password;
  17.     @NotNull(message = "First Name is mandatory")
  18.     private String firstName;
  19.     @NotNull(message = "Last Name is mandatory")
  20.     private String lastName;
  21.     @NotNull(message = "Email is mandatory")
  22.     @Email(message = "Not valid email")
  23.     @Indexed(unique=true)
  24.     private String email;
  25.     @NotNull(message = "Phone Number is mandatory")
  26.     private String phone;
  27.     private String address;
  28. }
复制代码
Step 2 建立MongoDB模板,映射MongoDB数据库操作

  1. package com.bjtu.repository;
  2. import com.bjtu.pojo.User;
  3. import org.springframework.data.mongodb.repository.MongoRepository;
  4. public interface UserRepository extends MongoRepository<User, String> {
  5.     User findByUserName(String userName);
  6. }
复制代码
详细创建数据库操作方法的说明详见官方文档

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

  1. package com.bjtu.dao;
  2. import com.bjtu.pojo.User;
  3. import java.util.List;
  4. /**
  5. * Registration APIs to register and update user
  6. *
  7. * @param <ID>                  - String/long
  8. * @param <USER>                - User
  9. * @author anshulbansal
  10. */
  11. public interface UserDao<ID, USER> {
  12.     /**
  13.      * Fetch user record using userName
  14.      *
  15.      * @param userName
  16.      * @return user
  17.      * @throws Exception
  18.      */
  19.     USER getUserByUserName(ID userName) throws Exception;
  20.     List<USER> getAllUser();
  21. }
复制代码
Step 4 编写Service层,实现DAO层接口

  1. package com.bjtu.service;
  2. import com.bjtu.dao.UserDao;
  3. import com.bjtu.pojo.User;
  4. import com.bjtu.repository.UserRepository;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.stereotype.Service;
  7. import java.util.List;
  8. @Service
  9. public class UserDaoImpl implements UserDao<String, User> {
  10.     @Autowired
  11.     private UserRepository userRepository;
  12.     @Override
  13.     public User getUserByUserName(String userName) throws Exception {
  14.         User user = userRepository.findByUserName(userName);
  15.         return user;
  16.     }
  17.     @Override
  18.     public List<User> getAllUser(){
  19.         List<User> users = userRepository.findAll();
  20.         return users;
  21.     }
  22. }
复制代码
Step 5 编写Controller层,实现restful数据接口

  1. package com.bjtu.controller;
  2. import com.bjtu.pojo.User;
  3. import com.bjtu.service.UserDaoImpl;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.http.HttpStatus;
  6. import org.springframework.http.ResponseEntity;
  7. import org.springframework.web.bind.annotation.*;
  8. import javax.validation.ConstraintViolationException;
  9. import java.util.HashMap;
  10. import java.util.List;
  11. import java.util.Map;
  12. @RestController
  13. @CrossOrigin
  14. public class UserController {
  15.     @Autowired
  16.     private UserDaoImpl registrationImpl;
  17.     @GetMapping("/getUserbyusername" )
  18.     public ResponseEntity getUserByUserName(@RequestParam("userName") String userName) throws Exception {
  19.         User user = registrationImpl.getUserByUserName(userName);
  20.         return new ResponseEntity<>(user, HttpStatus.OK);
  21.     }
  22.     @GetMapping("/getAllUser" )
  23.     public ResponseEntity getAllUser() throws Exception {
  24.         List<User> users = registrationImpl.getAllUser();
  25.         return new ResponseEntity<>(users, HttpStatus.OK);
  26.     }
  27. }
复制代码
Step 6 修改application.properties配置文件

  1. #MongoDB服务器地址
  2. #spring.data.mongodb.host=localhost
  3. spring.data.mongodb.host=192.168.100.91
  4. #MongoDB服务器端口
  5. spring.data.mongodb.port=27017
  6. #MongoDB身份验证数据库
  7. spring.data.mongodb.authentication-database=admin
  8. #MongoDB服务器用户名
  9. spring.data.mongodb.username=root
  10. #MongoDB服务器密码
  11. spring.data.mongodb.password=123456
  12. #所要操作的MongoDB数据库
  13. spring.data.mongodb.database=springboot_mongo_db
  14. #对外ip,默认localhost
  15. #server.address=192.168.10.2
  16. #对外端口
  17. server.port=8081
复制代码
Step 7 运行程序,浏览器访问相应接口进行测试

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

来源:https://blog.caogenba.net/qq_21482343/article/details/122427123
免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x

帖子地址: 

回复

使用道具 举报

分享
推广
火星云矿 | 预约S19Pro,享500抵1000!
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则

草根技术分享(草根吧)是全球知名中文IT技术交流平台,创建于2021年,包含原创博客、精品问答、职业培训、技术社区、资源下载等产品服务,提供原创、优质、完整内容的专业IT技术开发社区。
  • 官方手机版

  • 微信公众号

  • 商务合作