准备一个MySQL数据库,本地也好,云数据库也好,能链接上就行。
我创建了一个新的数据库csdn_course,暂时没有新建任何表
添加数据库连接
mysql mysql-connector-java 8.0.11 org.springframework.boot spring-boot-starter-jdbc
添加MyBatis相关依赖,我使用的bomidou的mybatis-plus
三、配置yml文件org.mybatis.spring.boot mybatis-spring-boot-starter 2.1.2 com.baomidou mybatis-plus-core 3.2.0 com.baomidou mybatis-plus-generator 3.2.0 org.apache.commons commons-lang3 3.11
配置数据库连接
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
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 + "!");
}
}
generator使用的模板 点击下载
首先创建一张User的表,包含简单的account和password字段。
运行代码生成器,输入模块名和对应表名
报错了,缺少freemarker,在pom文件中加入下面的依赖
org.freemarker freemarker 2.3.30
再启动输入创建代码,就成功了
生成后的项目代码路径
可以看到,自动生成了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; @Mapper public interface UserMapper extends BaseMapper{ }
修改后的项目包路径如下,添加了req和resp文件夹,分别用来放入参和返回结果类
至此,一个简单的框架就搭建起来了
在此之前 ,@Data注解的使用,需要在pom文件加上依赖
org.projectlombok lombok true
RegisterUserParam:注册用户入参
package com.luoye.csdn_course_server.user.req;
import lombok.Data;
@Data
public class RegisterUserParam {
private String account;
private String password;
}
首先写sql
UserMapper.xml
insert into user (account,password) value (#{param.account},#{param.password})
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; @Mapper public interface UserMapper extends BaseMapper{ 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; public interface IUserService extends IService{ 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; @Service @Slf4j public class UserServiceImpl extends ServiceImplimplements 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;
@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在下一篇中我来讲解如何使用。



