开发者社区> 三分恶> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

SpringCloud Alibaba实战(5:子模块基本业务开发)

简介: SpringCloud Alibaba实战(5:子模块基本业务开发)
+关注继续查看

源码地址:https://gitee.com/fighter3/eshop-project.git

持续更新中……

在上一节里,我们搭建了一个微服务项目的整体架构,并进行了版本控制。

接下来我们进一步来完善架构,引入SpringBootMybatisPlus等开发框架,来支撑具体业务的开发。

image.png

1、引入SpringBoot

我们在父项目统一管理引入的jar包的版本。

一般的SpringBoot项目是通过parent方式引入SpringBoott依赖,但是这样一来就违背了单个pom只有一个parent标签的标准。

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
      </parent>

所以我们采用父项目中以depencyMangement方式引入spring-boot,子项目依赖parent父配置即可。

    <!--使用properties统一管理版本-->
    <properties>
        <java.version>1.8</java.version>
        <spring.boot.version>2.2.2.RELEASE</spring.boot.version>
    </properties>

   <!--统一管理项目依赖版本-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring.boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

2、引入MybatisPlus

关于MybatisPlus的基本使用,基本使用可以查看我的这篇博客:SpringBoot学习笔记(十七:MyBatis-Plus )

MybatisPlus的官方文档做的也很不错,详细了解可以直接查看官方文档:https://mybatis.plus/

引入MybatisPlus依赖和MySQL驱动依赖:

<mybatis.plus.version>3.4.1</mybatis.plus.version>
            <!--mybatis-plus依赖-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-boot-starter</artifactId>
                <version>${mybatis.plus.version}</version>
            </dependency>
            <!--mybatis-plus代码生成器依赖-->
            <dependency>
                <groupId>com.baomidou</groupId>
                <artifactId>mybatis-plus-generator</artifactId>
                <version>${mybatis.plus.version}</version>
            </dependency>
            <!--模板引擎依赖,即使不需要生成模板,也需要引入-->
            <dependency>
                <groupId>org.apache.velocity</groupId>
                <artifactId>velocity-engine-core</artifactId>
                <version>2.2</version>
            </dependency>
            <!--mysql驱动-->
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
                <scope>runtime</scope>
            </dependency>

为了接口测试的方便,我们还引入了swagger2的增强工具knife4j

            <!--knife4j依赖-->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-spring-boot-starter</artifactId>
                <version>${knife4j-version}</version>
            </dependency>

3、使用MP代码生成器

接下来我们以用户模块为例,演示MybatisPlus代码生成器的使用。关于代码生成器的更多内容可以直接查看官方文档:https://mybatis.plus/guide/generator.html

在上面我们已经引进行了统一的依赖版本管理,在子模块里还需要引入依赖,不过可以免去版本号。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-generator</artifactId>
        </dependency>
        <!--模板引擎依赖,即使不需要生成模板,也需要引入-->
        <dependency>
            <groupId>org.apache.velocity</groupId>
            <artifactId>velocity-engine-core</artifactId>
            <version>2.2</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

我们还引入了lombok用来简化代码,使用lombok可以省去生成大量getter/setter代码。在Idea中使用需要安装插件,在插件里自行搜索安装即可。

  • 由于代码生成器与业务无关,所以将代码生成类建在测试目录下:

  • 代码生成器类的相关代码
public class MySQLCodeGenerator {
    /**
     * <p>
     * 读取控制台内容
     * </p>
     */
    public static String scanner(String tip) {
        Scanner scanner = new Scanner(System.in);
        StringBuilder help = new StringBuilder();
        help.append("请输入" + tip + ":");
        System.out.println(help.toString());
        if (scanner.hasNext()) {
            String ipt = scanner.next();
            if (StringUtils.isNotBlank(ipt)) {
                return ipt;
            }
        }
        throw new MybatisPlusException("请输入正确的" + tip + "!");
    }

    public static void main(String[] args) {
        // 代码生成器
        AutoGenerator mpg = new AutoGenerator();

        // 全局配置
        GlobalConfig gc = new GlobalConfig();
        //设置项目位置,这里直接设置为绝对路径
        String projectPath = "D:\\WorkSpace\\IdeaProjects\\eshop-project\\eshop-user";
        //输出目录
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("三分恶");
        gc.setOpen(false);
        gc.setSwagger2(true);     //实体属性 Swagger2 注解
        mpg.setGlobalConfig(gc);

        // 数据源配置
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/shop_user?characterEncoding=utf-8&allowMultiQueries=true&serverTimezone=GMT%2B8");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        mpg.setDataSource(dsc);

        //包配置
        PackageConfig pc = new PackageConfig();
        //模块名配置
        //pc.setModuleName(scanner("模块名"));
        pc.setParent("cn.fighter3");
        mpg.setPackageInfo(pc);

        // 自定义配置
        InjectionConfig cfg = new InjectionConfig() {
            @Override
            public void initMap() {
                // to do nothing
            }
        };


        ///策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        //strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
        //【实体】是否为lombok模型
        strategy.setEntityLombokModel(true);
        //生成 @RestController 控制器
        strategy.setRestControllerStyle(true);
        // 公共父类
        //strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
        // 写于父类中的公共字段
        //strategy.setSuperEntityColumns("id");
        strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
        strategy.setControllerMappingHyphenStyle(true);
        strategy.setTablePrefix(pc.getModuleName() + "_");
        mpg.setStrategy(strategy);
        mpg.execute();
    }
}

MP的代码生成器支持很多配置,包括基本配置、数据配置、数据库表配置等等。甚至可以自定义模板。具体可以查看:https://mybatis.plus/config/generator-config.html#%E5%9F%BA%E6%9C%AC%E9%85%8D%E7%BD%AE

image.png

  • 生成代码很简单,直接运行代码生成器类,输入表名就行了

1.gif

  • 生成的代码如下:

image.png

4、基本业务代码编写

接下来我们简单地在用户服务中编写一个基本的查看和增加的功能。

  • 在resource目录下添加配置文件application.yml,写入相关配置:
# 数据源配置
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://localhost:3306/shop_user?characterEncoding=utf-8&allowMultiQueries=true&serverTimezone=GMT%2B8
    username: root
    password: root
  • 在cn.fighter3包下手动创建启动类EshopUserApplication.java:
@SpringBootApplication
@MapperScan("cn.fighter3.mapper")
public class EshopUserApplication {

    public static void main(String[] args) {
        SpringApplication.run(EshopUserApplication.class, args);
    }
}
  • 在pom.xml文件中添加对common模块的依赖
        <dependency>
            <groupId>cn.fighter3</groupId>
            <artifactId>eshop-common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
  • 在common工程中创建统一的结果返回类
/**
 * @Author: 三分恶
 * @Date: 2021/5/16
 * @Description: 统一结果返回类
 **/
@Data
@Builder
@AllArgsConstructor
public class CommonResult<T> implements Serializable {

    private static final long serialVersionUID = 1L;

    @Tolerate
    public CommonResult() {
    }

    private Integer code;
    private String message;
    private T data;

    public static CommonResult ok() {
        return CommonResult.builder().code(200).message("请求成功").build();
    }

    public static CommonResult ok(Object data) {
        return CommonResult.builder().code(200).message("请求成功").data(data).build();
    }

    public static CommonResult error(String message) {
        return CommonResult.builder().code(500).message("响应异常").build();
    }

}
  • 在ShopUserController.java中编写相关接口的代码
/**
 * <p>
 * 用户表 前端控制器
 * </p>
 *
 * @author 三分恶
 * @since 2021-05-16
 */
@RestController
@RequestMapping("/shop-user")
@Api(value = "用户信息接口", tags = "用户接口")
public class ShopUserController {
    @Autowired
    private IShopUserService shopUserService;

    @PostMapping("/user/add")
    @ApiOperation(value = "添加用户接口")
    public CommonResult addUser(@RequestBody ShopUser shopUser) {
        this.shopUserService.save(shopUser);
        return CommonResult.ok();
    }

    @GetMapping("/user/get-by-id")
    @ApiOperation(value = "根据id获取用户信息接口")
    public CommonResult getUserById(@RequestParam Integer id) {
        ShopUser shopUser = this.shopUserService.getById(id);
        return CommonResult.ok(shopUser);
    }

}

运行启动类,启动项目,我们来看看运行的结果。

访问 http://127.0.0.1:8080/doc.html ,我们可以看到knife4j接口文档页面:

image.png

接下来测试一下我们的添加接口,可以看到请求成功,查看数据库表,发现也多了数据。

image.png

测试根据ID获取用户信息接口:

image.png

5、小问题

在开发的过程中使用了一些Jdk1.8的语法,发现出现 Error:(66, 87) java: -source 1.5 中不支持方法引用 (请使用 -source 8 或更高版本以启用方法引用) ,解决这个问题需要修改两处:

  • 在Idea中, 找到Build,Execution,Deployment >> Compiler >> Java Compiler ,把JDK版本改成8。
  • 在Idea中, File->Project Structure,在source中将Language level 从5.0改为8。

好了,我们基本的业务开发到这就算是完成了,其它服务萧规曹随就行了。


“简单的事情重复做,重复的事情认真做,认真的事情有创造性地做!”——

我是三分恶,可以叫我老三/三分/三哥/三子,一个能文能武的全栈开发,咱们下期见!


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Springboot Mybatis 、JPA 调用存储过程,实战教程
Springboot Mybatis 、JPA 调用存储过程,实战教程
31 0
SA实战 ·《SpringCloud Alibaba实战》项目说明、流程设计、技术选型与模块划分
SA实战 ·《SpringCloud Alibaba实战》项目说明、流程设计、技术选型与模块划分
111 0
【SpringCloud-Alibaba】2.搭建用户微服务模块。
本节是陆续搭建系统和编码的开始,我们会优先完成一个基础工程的创建。一般在互联网企业这部分工作可能不需要反复处理,只需要在承接产品需要后使用脚手架或者直接复制以往工程就可以创建现有需要使用的工程了。例如 Spring 官网也提供了创建工程的脚手架,https://start.spring.io Spring Initializr 本质上也是一个 Web 应用,它可以通过 Web 界面、Spring Tool Suite、IntelliJ IDEA 等方式,构建出一个基本的 Spring Boot 项目结构。因为我们是搭建微服务项目。所以这里我们需要进行基本的框架搭建。
176 0
SpringCloud Alibaba实战(4:基本开发框架搭建)
SpringCloud Alibaba实战(4:基本开发框架搭建)
218 0
Spring Cloud Alibaba 实战(3) - 微服务拆分与编写(中)
单体应用:一个归档包(例如war包)包含所有功能的应用程序,我们通常称为单体应用。而架构单体应用的方法论就是单体应用架构。
46 0
Spring Cloud Alibaba 2.2.7 版本正式发布
Spring Cloud Alibaba 是由阿里巴巴(后文简称:阿里)中间件团队于 2018 年 7 月开源,为业界提供的一套基于阿里内部分布式技术的一站式微服务构建解决方案。基于 Spring Cloud 微服务框架标准,针对微服务架构中的服务注册与发现、分布式消息、服务限流降级以及分布式事务等核心模块,都提供了相应的面向业界的成熟解决方案
353 0
Spring Cloud Alibaba 实战(八) - 审核业务的分布式事务处理实现
Github 本文主要讲解RabbitMQ的介绍和安装,Spring Cloud Stream核心概念,Spring Cloud Alibaba RocketMQ学习,异步消息推送与消费 1 审核业务的实现 com/javaedge/contentcenter/service/content/ShareService.
2248 0
Spring Cloud Alibaba 实战(三) - 微服务拆分与编写
1 概述 1.1 单体架构vs微服务架构 单体架构是什么 微服务是什么 微服务特性 微服务全景架构图 微服务优缺点 微服务适用场景 1.2 业务分析与建模 项目功能演示与分析 微服务拆分 项目架构图 数据库设计 API文档 1.3 编写微服务 创建小程序 创建项目 编写用户微服务 编写内容微服务 2 单体应用 一个归档包(例如war包)包含所有功能的应用程序,我们通常称为单体应用。
3431 0
Java秒杀系统实战系列~构建SpringBoot多模块项目
本文主要分享介绍如何采用IDEA,基于SpringBoot+SpringMVC+Mybatis+分布式中间件构建一个多模块的项目,即“秒杀系统”!。
1952 0
SpringCloud实战1-Eureka
熟悉微服务架构或Dubbo框架的都知道,微服务中最核心、最基础的组件就是注册中心了。下面利用Spring Cloud Eureka实现服务注册中心。并注册一个简单的服务提供者。 首先先创建一个spirngboot工程,并添加公用依赖。
1649 0
+关注
三分恶
一个能文能武的全栈开发~
340
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载