第一步：搭建项目基本框架
2024-05-16 00:17:50
新建项目及基本配置
1 IDEA新建Spring Boot项目
先从Idea上新建项目，过程选项一直下一步就可以了，路径名等请自定义。
2 搭建项目文档结构骨架
规范的项目路径便于问题的定位及项目的维护
3 添加Springboot项目基本配置文件
在application.yml中添加数据源配置和mybatis的mapper.xml的路径配置。
server:port: 8080spring:datasource:url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghaiusername: rootpassword: 123456mybatis:mapper-locations:- classpath:mapper/*.xml- classpath*:com/**/mapper/*.xml
整合mybatis及mbg
1 添加依赖
为了引入mybatis及mbg等相关组件，需要添加以下依赖：mybatis、mybatis-generator、druid、mysql-connector-java。
<!--mybatis-->
<dependency><groupId>org.mybatis</groupId><artifactId>mybatis</artifactId><version>3.4.6</version>
</dependency>
<!-- MyBatis 生成器 -->
<dependency><groupId>org.mybatis.generator</groupId><artifactId>mybatis-generator-core</artifactId><version>1.3.7</version>
</dependency>
<!--集成druid连接池-->
<dependency><groupId>com.alibaba</groupId><artifactId>druid-spring-boot-starter</artifactId><version>1.1.10</version>
</dependency>
<!--Mysql数据库驱动-->
<dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.15</version>
</dependency>
2 添加配置文件
配置数据库连接，Mybatis生成器生成模型，mapper接口及mapper.xml路径。
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfigurationPUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN""http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration><properties resource="generator.properties"/><context id="MySqlContext" targetRuntime="MyBatis3" defaultModelType="flat"><property name="beginningDelimiter" value="`"/><property name="endingDelimiter" value="`"/><property name="javaFileEncoding" value="UTF-8"/><!-- 为模型生成序列化方法--><plugin type="org.mybatis.generator.plugins.SerializablePlugin"/><!-- 为生成的Java模型创建一个toString方法 --><plugin type="org.mybatis.generator.plugins.ToStringPlugin"/><!--生成mapper.xml时覆盖原文件--><plugin type="org.mybatis.generator.plugins.UnmergeableXmlMappersPlugin" /><commentGenerator type="com.hzf.mymall.mgb.CommentGenerator"><!-- 是否去除自动生成的注释 true：是 ： false:否 --><property name="suppressAllComments" value="true"/><property name="suppressDate" value="true"/><property name="addRemarkComments" value="true"/></commentGenerator><jdbcConnection driverClass="${jdbc.driverClass}"connectionURL="${jdbc.connectionURL}"userId="${jdbc.userId}"password="${jdbc.password}"><!--解决mysql驱动升级到8.0后不生成指定数据库代码的问题--><property name="nullCatalogMeansCurrent" value="true" /></jdbcConnection><javaModelGenerator targetPackage="com.hzf.mymall.model" targetProject="src\main\java"/><sqlMapGenerator targetPackage="com.hzf.mymall.mapper" targetProject="src\main\resources"/><javaClientGenerator type="XMLMAPPER" targetPackage="com.hzf.mymall.mapper"targetProject="src\main\java"/><!--生成全部表tableName设为%--><table tableName="%"><generatedKey column="id" sqlStatement="MySql" identity="true"/></table></context>
</generatorConfiguration>
3 添加Mybatis的java配置
用于配置需要动态生成的mapper接口的路径
package com.hzf.mymall.config;import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Configuration;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：MyBatis配置类*/
@Configuration
@MapperScan({"com.hzf.mymall.mapper","com.hzf.mymall.dao"})
public class MyBatisConfig {}
4 编写MBG生成自动注释的规则
package com.hzf.mymall.mgb;import org.mybatis.generator.api.IntrospectedColumn;
import org.mybatis.generator.api.IntrospectedTable;
import org.mybatis.generator.api.dom.java.CompilationUnit;
import org.mybatis.generator.api.dom.java.Field;
import org.mybatis.generator.api.dom.java.FullyQualifiedJavaType;
import org.mybatis.generator.internal.DefaultCommentGenerator;
import org.mybatis.generator.internal.util.StringUtility;import java.util.Properties;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：*/public class CommentGenerator extends DefaultCommentGenerator {private boolean addRemarkComments = false;private static final String EXAMPLE_SUFFIX="Example";private static final String API_MODEL_PROPERTY_FULL_CLASS_NAME="io.swagger.annotations.ApiModelProperty";/*** 设置用户配置的参数*/@Overridepublic void addConfigurationProperties(Properties properties) {super.addConfigurationProperties(properties);this.addRemarkComments = StringUtility.isTrue(properties.getProperty("addRemarkComments"));}/*** 给字段添加注释*/@Overridepublic void addFieldComment(Field field, IntrospectedTable introspectedTable,IntrospectedColumn introspectedColumn) {String remarks = introspectedColumn.getRemarks();//根据参数和备注信息判断是否添加备注信息if(addRemarkComments&&StringUtility.stringHasValue(remarks)){// addFieldJavaDoc(field, remarks);//数据库中特殊字符需要转义if(remarks.contains("\"")){remarks = remarks.replace("\"","'");}//给model的字段添加swagger注解field.addJavaDocLine("@ApiModelProperty(value = \""+remarks+"\")");}}/*** 给model的字段添加注释*/private void addFieldJavaDoc(Field field, String remarks) {//文档注释开始field.addJavaDocLine("/**");//获取数据库字段的备注信息String[] remarkLines = remarks.split(System.getProperty("line.separator"));for(String remarkLine:remarkLines){field.addJavaDocLine(" * "+remarkLine);}addJavadocTag(field, false);field.addJavaDocLine(" */");}@Overridepublic void addJavaFileComment(CompilationUnit compilationUnit) {super.addJavaFileComment(compilationUnit);//只在model中添加swagger注解类的导入if(!compilationUnit.isJavaInterface()&&!compilationUnit.getType().getFullyQualifiedName().contains(EXAMPLE_SUFFIX)){compilationUnit.addImportedType(new FullyQualifiedJavaType(API_MODEL_PROPERTY_FULL_CLASS_NAME));}}
}
5 执行Generator Main函数生成model和mapper
package com.hzf.mymall.mgb;import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.internal.DefaultShellCallback;import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;/*** @author：010980380* @date:2020-10-21* @verison:1.0.0* @description：用于生成MBG的代码*/public class Generator {public static void main(String[] args) throws Exception {//MBG 执行过程中的警告信息List<String> warnings = new ArrayList<String>();//当生成的代码重复时，覆盖原代码boolean overwrite = true;//读取我们的 MBG 配置文件InputStream is = Generator.class.getResourceAsStream("/generatorConfig.xml");ConfigurationParser cp = new ConfigurationParser(warnings);Configuration config = cp.parseConfiguration(is);is.close();DefaultShellCallback callback = new DefaultShellCallback(overwrite);//创建 MBGMyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);//执行生成代码myBatisGenerator.generate(null);//输出警告信息for (String warning : warnings) {System.out.println(warning);}}
}
编写业务代码
1 添加Common类
基础的通用类包括：自定义操作码的接口、常用操作码的枚举，分页数据的封装类，通用的返回对象。
通用的返回对象
package com.hzf.mymall.common;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：通用返回对象*/public class CommonResult<T> {private long code;private String message;private T data;protected CommonResult(){}protected CommonResult(long code,String message,T data){this.code = code;this.message = message;this.data = data;}/*** 成功返回结果* @param data 获取的数据* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:43*/public static <T> CommonResult<T> success(T data){return new CommonResult<T>(ResultCode.SUCCESS.getCode(),ResultCode.SUCCESS.getMessage(),data);}/*** 成功返回结果* @param data 获取的数据* @param message 提示信息* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:43*/public static <T> CommonResult<T> success(T data,String message){return new CommonResult<T>(ResultCode.SUCCESS.getCode(),message,data);}/*** 失败返回结果* @param errorCode 错误码对象* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:49*/public static <T> CommonResult<T> failed(IErrorCode errorCode){return new CommonResult<T>(errorCode.getCode(),errorCode.getMessage(),null);}/*** 失败返回结果* @param errorCode 错误码对象* @param message 提示信息* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:50*/public static <T> CommonResult<T> failed(IErrorCode errorCode,String message){return new CommonResult<T>(errorCode.getCode(),message,null);}/*** 失败返回结果* @param message 提示信息* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:50*/public static <T> CommonResult<T> failed(String message){return new CommonResult<T>(ResultCode.FAILED.getCode(),message,null);}/*** 失败返回结果* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 15:51*/public static <T> CommonResult<T> failed(){return failed(ResultCode.FAILED);}/*** 参数验证失败返回结果* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 16:04*/public static <T> CommonResult<T> vaildateFailed(){return failed(ResultCode.VALIDATE_FAILED);}/*** 参数验证失败返回结果* @param message 提示信息* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 16:05*/public static <T> CommonResult<T> validateFailed(String message){return failed(ResultCode.VALIDATE_FAILED,message);}/*** 未登录返回结果* @param data * @return CommonResult<T>* @author huangzifan* @since 2020-10-26 16:04*/public static <T> CommonResult<T> unauthorized(T data){return new CommonResult<T>(ResultCode.UNAUTHORIZED.getCode(),ResultCode.UNAUTHORIZED.getMessage(),data);}/*** 未授权返回结果* @param data* @return CommonResult<T>* @author huangzifan* @since 2020-10-26 16:04*/public static <T> CommonResult<T> forbidden(T data){return new CommonResult<T>(ResultCode.FORBIDDEN.getCode(),ResultCode.FORBIDDEN.getMessage(),data);}public long getCode() {return code;}public void setCode(long code) {this.code = code;}public String getMessage() {return message;}public void setMessage(String message) {this.message = message;}public T getData() {return data;}public void setData(T data) {this.data = data;}
}
通用分页
package com.hzf.mymall.common;import com.github.pagehelper.PageInfo;import java.util.List;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：分页数据的封装类*/public class CommonPage<T> {private Integer pageNum;private Integer pageSize;private Integer totalpage;private Long total;private List<T> list;public static <T> CommonPage<T> restPage(List<T> list){CommonPage result =new CommonPage<T>();PageInfo<T> pageInfo = new PageInfo<T>(list);result.setPageNum(pageInfo.getPageNum());result.setPageSize(pageInfo.getPageSize());result.setTotalpage(pageInfo.getPages());result.setTotal(pageInfo.getTotal());result.setList(pageInfo.getList());return result;}public static <T> CommonPage<T> restPage(PageInfo<T> pageInfo){CommonPage result = new CommonPage<T>();result.setPageNum(pageInfo.getPageNum());result.setPageSize(pageInfo.getPageSize());result.setTotalpage(pageInfo.getPages());result.setTotal(pageInfo.getTotal());result.setList(pageInfo.getList());return result;}public Integer getPageNum() {return pageNum;}public void setPageNum(Integer pageNum) {this.pageNum = pageNum;}public Integer getPageSize() {return pageSize;}public void setPageSize(Integer pageSize) {this.pageSize = pageSize;}public Integer getTotalpage() {return totalpage;}public void setTotalpage(Integer totalpage) {this.totalpage = totalpage;}public Long getTotal() {return total;}public void setTotal(Long total) {this.total = total;}public List<T> getList() {return list;}public void setList(List<T> list) {this.list = list;}
}
自定义错误码接口
package com.hzf.mymall.common;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：自定义错误码接口*/public interface IErrorCode {long getCode();String getMessage();
}
常用操作码枚举
- SUCCESS 200
- FAILED 500
- UNAUTHORIZED 401
- FORBIDDEN 403
- VALIDATE_FAILED 404
package com.hzf.mymall.common;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：枚举常用的操作码*/
public enum ResultCode implements IErrorCode{SUCCESS(200,"操作成功"),FAILED(500,"操作失败"),VALIDATE_FAILED(404,"参数检验失败"),UNAUTHORIZED(401,"暂未登陆或token已经过期"),FORBIDDEN(403,"没有相关权限");private long code;private String message;ResultCode(long code, String message) {this.code = code;this.message = message;}@Overridepublic long getCode() {return code;}@Overridepublic String getMessage() {return message;}
}
2 添加Service接口（PmsBrand来演示）
package com.hzf.mymall.service;import com.hzf.mymall.model.PmsBrand;import java.util.List;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：PmsBrand Service接口*/public interface PmsBrandService {List<PmsBrand> listAllBrand();int createBrand(PmsBrand brand);int updateBrand(Long id,PmsBrand brand);int deleteBrand(Long id);List<PmsBrand> listBrand(int pageNum,int pageSize);PmsBrand getBrand(Long id);}
3 实现Service接口
package com.hzf.mymall.service.impl;import com.github.pagehelper.PageHelper;
import com.hzf.mymall.mapper.PmsBrandMapper;
import com.hzf.mymall.model.PmsBrand;
import com.hzf.mymall.model.PmsBrandExample;
import com.hzf.mymall.service.PmsBrandService;
import org.springframework.beans.factory.annotation.Autowired;import java.util.List;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：PmsBrand 实现类*/public class PmsBrandServiceImpl implements PmsBrandService {@Autowiredprivate PmsBrandMapper brandMapper;@Overridepublic List<PmsBrand> listAllBrand() {return brandMapper.selectByExample(new PmsBrandExample());}@Overridepublic int createBrand(PmsBrand brand) {return brandMapper.insertSelective(brand);}@Overridepublic int updateBrand(Long id,PmsBrand brand) {brand.setId(id);return brandMapper.updateByPrimaryKeySelective(brand);}@Overridepublic int deleteBrand(Long id) {return brandMapper.deleteByPrimaryKey(id);}@Overridepublic List<PmsBrand> listBrand(int pageNum, int pageSize) {PageHelper.startPage(pageNum,pageSize);return brandMapper.selectByExample(new PmsBrandExample());}@Overridepublic PmsBrand getBrand(Long id) {return brandMapper.selectByPrimaryKey(id);}
}
4 实现Controller类
package com.hzf.mymall.controller;import com.hzf.mymall.common.CommonPage;
import com.hzf.mymall.common.CommonResult;
import com.hzf.mymall.model.PmsBrand;
import com.hzf.mymall.service.PmsBrandService;
import org.slf4j.ILoggerFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.*;import javax.xml.ws.RequestWrapper;
import java.util.List;/*** @author：010980380* @date:2020-10-26* @verison:1.0.0* @description：品牌管理 Controller*/
@Controller
@RequestMapping("/brand")
public class PmsBrandController {@Autowiredprivate PmsBrandService demoService;private static final Logger LOGGER = LoggerFactory.getLogger(PmsBrandController.class);@RequestMapping(value = "listAll", method = RequestMethod.GET)@ResponseBodypublic CommonResult<List<PmsBrand>> getBrandList(){return CommonResult.success(demoService.listAllBrand());}@RequestMapping(value = "/list", method = RequestMethod.GET)@ResponseBodypublic CommonResult<CommonPage<PmsBrand>> listBrand(@RequestParam(value = "pageNum", defaultValue = "1") Integer pageNum,@RequestParam(value = "pageSize", defaultValue = "3") Integer pageSize){List<PmsBrand> brandList = demoService.listBrand(pageNum,pageSize);return CommonResult.success(CommonPage.restPage(brandList));}@RequestMapping(value = "/{id}", method = RequestMethod.GET)@ResponseBodypublic CommonResult<PmsBrand> Brand(@PathVariable("id") Long id){return CommonResult.success(demoService.getBrand(id));}@RequestMapping(value = "/create", method = RequestMethod.POST)@ResponseBodypublic CommonResult createBrand(@RequestBody PmsBrand pmsBrand){CommonResult commonResult;int count = demoService.createBrand(pmsBrand);if(count == 1){commonResult = CommonResult.success(pmsBrand);LOGGER.debug("create Brand success:{}",pmsBrand);}else {commonResult = CommonResult.failed("操作失败");LOGGER.debug("createBrand failed:{}",pmsBrand);}return commonResult;}@RequestMapping(value = "/update/{id}", method = RequestMethod.POST)@ResponseBodypublic CommonResult updateBrand(@PathVariable("id") Long id, @RequestBody PmsBrand pmsBrandDto, BindingResult result){CommonResult commonResult;int count = demoService.updateBrand(id,pmsBrandDto);if(count == 1){commonResult = CommonResult.success(pmsBrandDto);LOGGER.debug("updateBrand success:{}",pmsBrandDto);}else {commonResult = CommonResult.failed("操作失败");LOGGER.debug("updateBrand failed:{}",pmsBrandDto);}return commonResult;}@RequestMapping(value = "/delete/{id}", method = RequestMethod.GET)@ResponseBodypublic CommonResult deleteBrand(@PathVariable("id") Long id){int count = demoService.deleteBrand(id);if(count == 1){LOGGER.debug("deleteBrand success:{}",id);return CommonResult.success(null);}else{LOGGER.debug("deleteBrand failed:{}",id);return CommonResult.failed("操作失败");}}}
运行项目并验证
第一步：搭建项目基本框架相关推荐
- [2014年学习计划之RoR系列] 第一步 - 搭建开发环境
千里之行始于足下.昨天下午开始我迈出了RoR学习的第一步 - 搭建Ruby on Rails环境. 我现在的主要开发环境是ASP.NET,所以想在Windows上搭建RoR的开发环境.在网上浏览一番, ...
- windows phone开发第一步:搭建软件开发环境
2019独角兽企业重金招聘Python工程师标准>>> windows phone开发第一步:搭建软件开发环境:http://www.cnblogs.com/hanjun/archi ...
- 建木(Jianmu)----迈出建木第一步创建项目分组
[原文链接] 1 建木简介 下面一段是摘自建木官网的一段话,用来对建木做一个简单的介绍: "建木"是上古先民崇拜的一种圣树,传说建木是沟通天地人神的桥梁.伏羲.黄帝等众帝都是通过这 ...
- 仿新浪微博IOS客户端（v5.2.8）——搭建项目基本框架
转载请标明出处:http://blog.csdn.net/android_ls/article/details/45827719 声明:仿新浪微博项目,所用所有图片资源都来源于官方新浪微博IOS客户端 ...
- 搭建App主流框架_纯代码搭建(OC)
转载自:http://my.oschina.net/hejunbinlan/blog/529778?fromerr=EmSuX7PR 搭建主流框架界面 源码地址在文章末尾 达成效果 效果图 注:本文部 ...
- storyboard搭建项目_轻松搞定一人一个storyboard开发
前言 storyboard已经推出有几年了,苹果也一直卖力的引导开发者使用storyboard开发,这点从我们创建工程,新工程以Main. storyboard创建window窗口就可以看出.然而很多 ...
- 4个步骤，搭建接口测试自动化框架
背景 在上一篇文章中,我们回顾了当前主流的几种接口测试自动化框架.今天将分享如何通过4个步骤,自己搭建一套完整的接口测试自动化框架. 搭建框架四部曲 框架的第一步 搭建框架的第一步是根据我们选择的自动 ...
- aws搭建java项目_AWS 创建开源 UI 项目：这是新开源设计系统的第一步
Amazon Web Services 发布了 AWS UI 以及 Porting Assistant for .NET UI,后者使用了前者的组件,并且已公开源代码仓库.而 AWS UI 项目根据 ...
- vue(vue-cli+vue-router)+babel+webpack项目搭建入门 （第一步）
vue(vue-cli+vue-router)+babel+webpack项目搭建入门<一> 本系列文章将介绍基于vue+webpack的前端项目的构建过程.文章分为四章内容,第一章介绍开 ...
最新文章
- 说说JSON和JSONP，也许你会豁然开朗
- 运维笔记10 （Linux软件的安装与管理（rpm，yum））
- 读数据库遇到空就进行不下去_如何保证缓存与数据库的双写一致性？
- Java第五次作业--面向对象高级特性（抽象类和接口）
- 实践 + 理论 | API 接口安全性设计
- Pacemaker 安装与使用
- sql中毫秒数与格式化时间的转换
- 九九乘法表c语言四种,C语言实现九九乘法表（四种情况）
- 习题合集-数据结构导论
- Arduino（c） 16进制转字符串
- 现代通信技术之软交换技术和IMS技术
- 基于Python+Opencv的银行卡号识别系统（附完整代码）
- 使用git上传uni-app项目到Gitee
- 什么是PERT网络分析?
- 计算机音乐红色彼岸花,红色彼岸花 - 刘雨Key - 5SING中国原创音乐基地
- 银行卡收单相关文章汇集
- python数据录入和分析_基于 Python 和 Pandas 的数据分析(3) --- 输入/输出 基础
- 数学家张益唐亲自评价关于攻克朗道西格尔零点猜想这个研究成果和意义！
- Android暗黑模式
- python程序执行完后重头开始做烧饼_从“程序员转行卖烧饼”想到IT人创业