Mall电商实战项目（一）

一、项目搭建

前言：一般在开发项目时，一般会搭建一个项目骨架，当我们能自己搭建项目骨架，并使用它能开发出一些相应的功能时，基本就可以熟练使用骨架中的技术。

该项目搭建的骨架主要步骤如下：

• 整合MyBatis实现CRUD
• 整合Swagger实现API接口文档
• 整合Radis实现缓存
• 整合Spring Security+JWT实现认证和授权
• 整合Spring Task实现定时任务
• 整合Elasticsearch实现商品搜索
• 整合MongoDB实现文档操作
• 整合RabbitMQ实现延迟消息
• 整合OSS实现文件上传

一、mall整合SpringBoot+MyBatis搭建基本骨架

1、mysql数据库环境搭建

链接: 数据库链接

2、项目使用框架介绍

1、SpringBoot

SpringBoot可以让你快速构建基于Spring的Web应用程序，内置了多种Web容器（如Tomcat），通过启动入口程序中的main函数即可

2、PageHelper

Mybatis分页插件，简洁的代码即可实现分页。

3、Druid

alibaba开源的数据库连接池，号称Java语言中最好的数据库连接池

4、Mybatis generator

Mybatis的代码生成器，可以根据数据库生成model、mapper.xml、mapper接口和Example，同城情况下的单表查询不用再手写mapper。

3、项目搭建

1、使用IDEA初始化一个SpringBoot项目

@SpringBootApplication

该注解是三个注解的结合体，拥有以下三个注解的功能：
1、@Configuration：用于声明Spring中的Java配置；
2、@ComponScan：启动扫描组件，当我们声明组件时，会自动发现并注册成为Spring应用上下文中的Bean；
3、@EnableAutoConfiguration：开启SpringBoot自动配置功能，简化配置编写。

2、配置依赖

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.scut.mall.tiny</groupId>
    <artifactId>mall-tiny-boot</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>mall-tiny-boot</name>
    <description>商城项目</description>
    <properties>
        <java.version>1.8</java.version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

<!--        Mybatis分页插件-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>

<!--        集成druid连接池-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.13</version>
        </dependency>
<!--        Mybatis生成器-->
        <dependency>
            <groupId>org.mybatis.generator</groupId>
            <artifactId>mybatis-generator-core</artifactId>
            <version>1.3.3</version>
        </dependency>

<!--        mysql数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

3、修改SpringBoot配置文件

在application.yml文件中添加数据源配置和MyBatis的mapper.xml的路径配置。

server:
  port: 8080
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mall?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
mybatis:
  mapper-locations: 
    - classpath:mapper/*.xml
    - classpath*:com/**/mapper/*.xml

4、Mybatis generator配置文件

配置数据库连接，Mybatis generator 生成model、mapper接口以及mapper.xml的路径

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
        PUBLIC "-//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"/>
        <!--可以自定义生成model的代码注释-->
        <commentGenerator type="com.macro.mall.tiny.mbg.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>
        <!--指定生成model的路径-->
        <javaModelGenerator targetPackage="com.macro.mall.tiny.mbg.model" targetProject="mall-tiny-01\src\main\java"/>
        <!--指定生成mapper.xml的路径-->
        <sqlMapGenerator targetPackage="com.macro.mall.tiny.mbg.mapper" targetProject="mall-tiny-01\src\main\resources"/>
        <!--指定生成mapper接口的的路径-->
        <javaClientGenerator type="XMLMAPPER" targetPackage="com.macro.mall.tiny.mbg.mapper"
                             targetProject="mall-tiny-01\src\main\java"/>
        <!--生成全部表tableName设为%-->
        <table tableName="pms_brand">
            <generatedKey column="id" sqlStatement="MySql" identity="true"/>
        </table>
    </context>
</generatorConfiguration>

5、运行generator的main函数生成代码

package com.scut.mall.tiny.mbg;


import org.mybatis.generator.api.MyBatisGenerator;
import org.mybatis.generator.config.Configuration;
import org.mybatis.generator.config.xml.ConfigurationParser;
import org.mybatis.generator.exception.XMLParserException;
import org.mybatis.generator.internal.DefaultShellCallback;

import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

/**
 * 用于生成MBG的代码
 */
public class Generator {
    public static void main(String[] args) throws Exception {
        //MBG执行过程中的警告信息
        List<String> warnings = new ArrayList<>();
        //当生成的代码重复时，覆盖源代码
        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);
        //创建MBG
        MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings);
        //执行生成代码
        myBatisGenerator.generate(null);
        //输出警告信息
        for (String warning : warnings){
            System.out.println(warning);
        }

    }
}

二、mall整合Swagger-UI实现在线API文档

一、项目使用框架介绍

1、Swagger-UI

Swagger-UI是HTML，JavaScript。CSS的一个集合，可以动态的根据注解生成在线API文档
常用注解如下所示：

@Api:用于修饰Controller类，生成Controller相关文档
@ApiOperation:用于修饰Controller类中的方法，生成接口方法相关文档信息
@ApiParam:用于修饰接口中的参数，生成接口参数相关文档信息
@ApiModelProperty:用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息

二、整合Swagger-UI

一、添加项目依赖

在pom.xml中新增Swagger-UI相关依赖

<!--        Swagger-UI API文档生成工具-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
        </dependency>

二、添加Swagger-UI的配置

Swagger对生成的API文档的范围有三种不同的选择

• 生成指定包下面的类的API文档
• 生成指定注解下面的类的API文档
• 生成指定注解下面的方法的API文档

package com.scut.mall.tiny.config;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Config {

   public Docket createRestApi(){
       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(apiInfo())
               .select()
               //为当前包下的controller生成API文档
               .apis(RequestHandlerSelectors.basePackage("com.scut.mall.tiny.controller"))
               //为有@Api注解的Contrller生成API文档
               .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
               //为有@ApiOperation注解的方法生成API文档
               .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
               .paths(PathSelectors.any())
               .build();
   }

   private ApiInfo apiInfo(){
       return new ApiInfoBuilder()
               .title("Swagger-UI演示")
               .description("mall-tiny")
               .contact("scut")
               .version("1.0")
               .build();
   }
}

三、给PmsBrandController添加Swagger注解

即在contrller中添加@Api和@ApiOperation相关的注解

四、修改Mybatis Generator注释的生成规则

CommentGenerator为Mybatis Generator 的自定义注释生成器，修改addFiledComment方法，使其能在import中导入@ApiModelProperty，否则需要手动导入，这是一件非常麻烦的事情。

五、运行代码生成器重新生成mbg包中的代码

生成代码后，运行项目，查看结果。访问http://localhost:8080/swagger-ui.html进行测试。