一、准备数据库
准备一个MySQL数据库,本地也好,云数据库也好,能链接上就行。
我创建了一个新的数据库csdn_course,暂时没有新建任何表
二、添加pom相关依赖
添加数据库连接
<!-- mysql链接驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.11</version>
</dependency>
<!-- 引入jdbc链接依赖 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
添加MyBatis相关依赖,我使用的bomidou的mybatis-plus
<!-- mybatis设置-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.2</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-core</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.2.0</version>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.11</version>
</dependency>
三、配置yml文件
配置数据库连接
spring:
application:
name: csdn_course_server
datasource:
# 数据库版本5以上的使用这个连接驱动
driver-class-name: com.mysql.cj.jdbc.Driver
# 数据库版本5的使用这个连接驱动
# driver-class-name: com.mysql.jdbc.Driver
username: yonghumi #数据库用户名
password: mima #数据库密码
url: jdbc:mysql://127.0.0.1:3306/csdn_course?useUnicode=true&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=GMT%2B8
PS:如果yml中链接驱动报红,重新Reload一下pom文件
配置MyBatis
mybatis:
mapper-locations: classpath:mapper/*/*.xml
type-aliases-package: com.luoye.platform.*.*.entity
configuration:
map-underscore-to-camel-case: true
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
项目中所有的mapper.xml是放到resource文件下的mapper文件夹内统一管理的。下面会贴一张项目模块的模板图片。使用的代码生成器以及生成代码的模板会提供下载链接。
CodeGenerator.Class
package com.luoye.csdn_course_server.common.generator;
import com.baomidou.mybatisplus.core.exceptions.MybatisPlusException;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.*;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;
import com.baomidou.mybatisplus.generator.engine.FreemarkerTemplateEngine;
import org.apache.commons.lang3.StringUtils;
import java.util.Scanner;
/**
* mybatis plus 提供的代码生成器
* 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码
*
* @link https://mp.baomidou.com/guide/generator.html
*/
public class CodeGenerator {
// 数据库 URL
private static final String URL = "jdbc:mysql://127.0.0.1:3306/csdn_course?useUnicode=true&characterEncoding=utf8&useSSL=false&allowPublicKeyRetrieval=true&serverTimezone=GMT%2B8";
// 数据库驱动
private static final String DRIVER_NAME = "com.mysql.cj.jdbc.Driver";
// private static final String DRIVER_NAME = "com.mysql.jdbc.Driver";
// 数据库用户名
private static final String USERNAME = "yonghuming";
// 数据库密码
private static final String PASSWORD = "mima";
// @author 值
private static final String AUTHOR = "LUOYE";
// 包的基础路径
private static final String BASE_PACKAGE_URL = "com.luoye.csdn_course_server";
// entity 文件模板
private static final String ENTITY_TEMPLATE_PATH = "generator/templates/entity.java";
// service 文件模板
private static final String SERVICE_TEMPLATE_PATH = "generator/templates/service.java";
// serviceImpl 文件模板
private static final String SERVICE_IMPL_TEMPLATE_PATH = "generator/templates/serviceImpl.java";
// controller 文件模板
private static final String CONTROLLER_TEMPLATE_PATH = "generator/templates/controller.java";
public static void main(String[] args) {
AutoGenerator generator = new AutoGenerator();
// 全局配置
GlobalConfig globalConfig = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
globalConfig.setOutputDir(projectPath + "/src/main/java");
globalConfig.setAuthor(AUTHOR);
globalConfig.setOpen(false);
globalConfig.setFileOverride(false);
globalConfig.setSwagger2(true);
generator.setGlobalConfig(globalConfig);
// 数据源配置
DataSourceConfig dataSourceConfig = new DataSourceConfig();
dataSourceConfig.setUrl(URL);
dataSourceConfig.setDriverName(DRIVER_NAME);
dataSourceConfig.setUsername(USERNAME);
dataSourceConfig.setPassword(PASSWORD);
generator.setDataSource(dataSourceConfig);
// 包配置
PackageConfig packageConfig = new PackageConfig();
packageConfig.setModuleName(scanner("模块名"));
packageConfig.setParent(BASE_PACKAGE_URL);
generator.setPackageInfo(packageConfig);
// 配置自定义代码模板
TemplateConfig templateConfig = new TemplateConfig();
templateConfig.setEntity(ENTITY_TEMPLATE_PATH);
templateConfig.setService(SERVICE_TEMPLATE_PATH);
templateConfig.setServiceImpl(SERVICE_IMPL_TEMPLATE_PATH);
templateConfig.setController(CONTROLLER_TEMPLATE_PATH);
generator.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setEntityLombokModel(true);
strategy.setEntityTableFieldAnnotationEnable(true);
strategy.setRestControllerStyle(true);
strategy.setInclude(scanner("表名"));
strategy.setSuperEntityColumns("id");
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(packageConfig.getModuleName() + "_");
generator.setStrategy(strategy);
generator.setTemplateEngine(new FreemarkerTemplateEngine());
generator.execute();
}
private static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
System.out.println(("请输入" + tip + ":"));
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) return ipt;
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
}
首先创建一张User的表,包含简单的account和password字段。
运行代码生成器,输入模块名和对应表名
报错了,缺少freemarker,在pom文件中加入下面的依赖
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.30</version>
</dependency>
再启动输入创建代码,就成功了
生成后的项目代码路径
可以看到,自动生成了user模块下的service、mapper、controller和实体类entity。但是因为我们配置的mapper.xml需要统一放到resources下的mapper文件夹管理,并且mapper文件(不是xml是绿色的那个)我们需要加上一个@Mapper注解(因为没有配置@MapperScan)
package com.luoye.csdn_course_server.user.mapper;
import com.luoye.csdn_course_server.user.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
/**
* <p>
* Mapper 接口
* </p>
*
* @author LUOYE
* @since 2022-06-15
*/
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
修改后的项目包路径如下,添加了req和resp文件夹,分别用来放入参和返回结果类
至此,一个简单的框架就搭建起来了
四、写个简单的用户注册接口
在此之前 ,@Data注解的使用,需要在pom文件加上依赖
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
RegisterUserParam:注册用户入参
package com.luoye.csdn_course_server.user.req;
import lombok.Data;
/**
* @Classname RegisterUserParam
* @Description TODO
* @Date 2022/6/15 17:10
* @Created LUOYE
*/
@Data
public class RegisterUserParam {
private String account;
private String password;
}
首先写sql
UserMapper.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.luoye.csdn_course_server.user.mapper.UserMapper">
<insert id="insert" parameterType="com.luoye.csdn_course_server.user.entity.User">
insert into user (account,password) value (#{param.account},#{param.password})
</insert>
</mapper>
UserMapper(xml的映射mapper)
package com.luoye.csdn_course_server.user.mapper;
import com.luoye.csdn_course_server.user.entity.User;
import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.apache.ibatis.annotations.Mapper;
import org.apache.ibatis.annotations.Param;
/**
* <p>
* Mapper 接口
* </p>
*
* @author NTY
* @since 2022-06-15
*/
@Mapper
public interface UserMapper extends BaseMapper<User> {
int insert(@Param("param") User user);
}
再来写service
IUserService.java
package com.luoye.csdn_course_server.user.service;
import com.luoye.csdn_course_server.user.entity.User;
import com.baomidou.mybatisplus.extension.service.IService;
import com.luoye.csdn_course_server.user.req.RegisterUserParam;
/**
* @author NTY
*/
public interface IUserService extends IService<User> {
String registerUser(RegisterUserParam param);
}
IUserService的实现类UserServiceImpl.java
package com.luoye.csdn_course_server.user.service.impl;
import com.luoye.csdn_course_server.user.entity.User;
import com.luoye.csdn_course_server.user.mapper.UserMapper;
import com.luoye.csdn_course_server.user.req.RegisterUserParam;
import com.luoye.csdn_course_server.user.service.IUserService;
import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.BeanUtils;
import org.springframework.stereotype.Service;
/**
* @author NTY
*/
@Service
@Slf4j
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
@Override
public String registerUser(RegisterUserParam param) {
User user = new User();
BeanUtils.copyProperties(param,user);
int result = this.baseMapper.insert(user);
return result > 0 ? "注册成功" : "注册失败";
}
}
最后再来编写controller接口
package com.luoye.csdn_course_server.user.controller;
import com.luoye.csdn_course_server.user.req.RegisterUserParam;
import com.luoye.csdn_course_server.user.service.IUserService;
import org.apache.commons.lang3.StringUtils;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;
/**
* @author NTY
*/
@RestController
@RequestMapping("/user")
public class UserController {
@Resource
private IUserService userService;
@PostMapping(value = "/register")
public String registerAccount(@RequestBody RegisterUserParam param){
if(!StringUtils.isNotBlank(param.getAccount())||!StringUtils.isNotBlank(param.getPassword())){
return "请输入账号或密码";
}
return userService.registerUser(param);
}
}
最后我们启动项目,请求接口测试一下
URL:http://localhost:18029/user/register
请求参数:
{
"account":"落叶",
"password":"112234"
}
使用postman或者其他接口请求测试软件发送请求测试一下
接口请求成功,返回注册成功,再看数据库中
数据库中也存储了刚刚请求的数据
PS:如果你按照我的步骤启动项目失败,可能是因为Entity包下的实体类User在代码生产的时候使用了Swagger,可以先注释掉相关的注解,Swagger在下一篇中我来讲解如何使用。