XwFast,我开发了一个基于SpringBoot和MyBatisPlus的敏捷开发框架!

简介: XwFast,我开发了一个基于SpringBoot和MyBatisPlus的敏捷开发框架!


🚀 A Cutting-edge Tool For Rapid Java Web Development.

👉 http://xuewei.world 👈


🚀简介

XwFast 是专为 Java Web 开发的基于 Spring 系列框架封装的黑科技脚手架,通过诸多实用工具类/组件的使用,旨在帮助开发者快速、便捷地完成各类开发任务。这些封装的工具组件涵盖了基础增删查改接口、邮件客户端、短信客户端、等一系列操作,可以满足各种不同的开发需求。

❤️理念

XwFast 旨在解放程序员生产力,用最少的代码做最多的事,将您的宝贵时间放在复杂业务和提升自我上,简单的事就交给 XwFast 吧!

🛠️组件

XwFast

采用了组件式的架构设计,您可按需引入所需要的模块,当然如果您是成年人,“成年人不做选择,我全都要!”,您可直接引入 xw-fast-all

模块 介绍
xw-fast-all 关于 XwFast 的全部内容
xw-fast-core 核心,包括的各种工具类、异常定义等
xw-fast-crud 封装基础增删查改的基础接口、基础实体的封装
xw-fast-web 封装一些开箱即用的 Spring 组件

📦安装

🍊Maven

在项目的 pom.xmldependencies 中加入以下内容:

<!-- 引入 Xw-Fast -->
<dependency>
    <groupId>world.xuewei</groupId>
    <artifactId>xw-fast-all</artifactId>
    <version>1.0.6</version>
</dependency>

📥下载jar

点击链接,下载 xw-fast-all-X.X.X.jar

即可,Maven中央库

📝文档

前往查看官方示例 xw-fast-demo

快速开始

创建一个基础的 SpringBoot 项目,引入下面依赖:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
        <version>2.7.17</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.7.17</version>
    </dependency>
    <!-- MyBatis Plus -->
    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.2.0</version>
    </dependency>
    <!-- MySQL -->
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
        <scope>runtime</scope>
        <version>5.1.48</version>
    </dependency>
    <!-- Druid -->
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.2.8</version>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid-spring-boot-starter</artifactId>
        <version>1.2.8</version>
    </dependency>
    <!-- 引入 Xw-Fast -->
    <dependency>
        <groupId>world.xuewei</groupId>
        <artifactId>xw-fast-all</artifactId>
        <version>1.0.6</version>
    </dependency>
</dependencies>

将 XwFast 的组件配置给 SpringBoot 扫描:

@ComponentScan(value = {"world.xuewei.fast", "你自己的项目包路径"})
@SpringBootApplication
public class XwFastDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(XwFastDemoApplication.class, args);
    }
}

在 SpringBoot 配置文件中正常配置数据源等信息,之后创建基础目录结构,如下(也可按照自己的想法自行设计):

controller

控制器包,编写控制器时继承 XwFast 封装的 BaseController,传入绑定的实体泛型。也可以在当前控制器类上声明注解

@FastController,XwFast 会自动注册这些增删查改接口。

点击链接查看接口示例

👉 基础增删查改接口示例 - XwFast

@RestController
@RequestMapping("/Example")
public class ExampleController extends BaseController<Example> {
    public ExampleController(ExampleService service) {
        super(service);
    }
    // Write Your Code Here ...
}
@RestController
@FastController
@RequestMapping("/Example")
public class ExampleController {
    @Autowired
    private ExampleService service;
    // Write Your Code Here ...
}
service

业务实现层,编写服务时继承 XwFast 封装的 BaseDBService,里面像 MyBatisPlus 一样封装了增删查改的接口,如果想问区别的话,那么我只能说

XwFast 更全面!

@Service
public class ExampleService extends BaseDBService<Example> {
    public ExampleService(ExampleMapper mapper) {
        super(mapper);
    }
    // Write Your Code Here ...
}
mapper

数据库访问层,和 Dao 是同一个意思,这里你可以直接继承自 MyBatisPlus 的 BaseMapper 类,传入实泛型。

@Mapper
public interface ExampleMapper extends BaseMapper<Example> {
    // Write Your Code Here ...
}
entity

数据库实体包,编写实体时继承 XwFast 封装的 BaseEntity,涉及到一些数据库的基础字段。

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@TableName("example")
@EqualsAndHashCode(callSuper = true)
public class Example extends BaseEntity implements Serializable {
    private static final long serialVersionUID = 541179640568881082L;
    /**
     * 编码
     */
    private String code;
    /**
     * 名称
     */
    private String name;
    /**
     * 备注
     */
    private String remark;
}

以上步骤做完之后那么恭喜你,运行服务就可以打开 Postman、Apifox 等接口测试工具测试了!

接口文档可查看示例:基础增删查改接口示例 - XwFast

如果你觉得创建、编写上面的几个类文件麻烦的话,XwFast 也帮你想了办法,你可以下载一个名为 EasyCode 的 IDEA

插件,这个插件可以帮你一键生成对应的实体、服务、DAO、Controller 等。但是你需要将 XwFast 提供的代码模板导入到你的 IDEA 配置。

可关注我的公众号:【薛伟同学】,后台回复【XwFast模板】获取代码模板。

【B站 - EasyCode使用教学视频 - 薛伟同学】

🏗️添砖加瓦

🌵分支说明

XwFast 的源码分为两个分支,功能如下:

分支 说明
main 🚩 主分支,release 版本使用的分支,与中央库提交的 jar 一致,不接收任何 pr 或修改
dev 🏴 开发分支,默认为下个版本的 SNAPSHOT 版本,接受修改或 pr

🐞提供bug反馈或建议

提交问题反馈请说明正在使用的 JDK 版本、XwFast 版本和相关依赖库版本。

Issues · XwFast

💡贡献代码的步骤

  1. 在 Github 上 fork 项目到自己的 repo
  2. 把 fork 过去的项目也就是你的项目 clone 到你的本地
  3. 修改代码(记得一定要修改 dev 分支)
  4. commit 后 push 到自己的库(dev分支)
  5. 登录 Github 在你首页可以看到一个 Pull Request 按钮,点击它,填写一些说明信息,然后提交即可
  6. 等待维护者合并

📐PR遵照的原则

XwFast 欢迎任何人为 XwFast 添砖加瓦,贡献代码,不过维护者是一个强迫症患者,为了照顾病人,需要提交的 pr(pull

request)符合一些规范,规范如下:

  1. 注释完备,尤其每个新增的方法应按照 Java 文档规范标明方法说明、参数说明、返回值说明等信息,必要时请添加单元测试,如果愿意,也可以加上你的大名。
  2. XwFast 代码的缩进按照默认(tab)缩进,所以请遵守(不要和我争执空格与 tab 的问题,这是一个病人的习惯)。
  3. 请 pull request 到 dev 分支。
  4. 我们如果关闭了你的 issue 或 pr,请不要诧异,这是我们保持问题处理整洁的一种方式,你依旧可以继续讨论,当有讨论结果时我们会重新打开。
相关文章
|
9天前
|
小程序 数据可视化 Java
Java+后端Spring boot 开发的全套UWB定位方案,0.1米高精度定位系统源码
UWB定位系统由硬件定位设备、定位引擎和应用软件组成。该定位系统应用软件支持PC端和移动端访问,并提供位置实时显示、历史轨迹回放、人员考勤、电子围栏、行为分析、智能巡检等功能。定位精度高达10cm,同时具备高动态、高容量、低功耗的优点。应用场景包括:隧道、化工、工厂、煤矿、工地、电厂、养老、展馆、整车、机房、机场等。
34 8
|
3天前
|
前端开发 JavaScript Java
计算机java项目|springboot基于spring框架的电影订票系统
计算机java项目|springboot基于spring框架的电影订票系统
|
6天前
|
SQL Java 关系型数据库
Java中的ORM框架——myBatis
Java中的ORM框架——myBatis
|
3天前
|
缓存 Java 程序员
你能不能手敲出Spring框架?
Spring最成功的地方在于创始人Rod Johnson提出的,反而不是其本身的技术。技术上今天可以有Spring春天,明天就可以有Autumn秋天。核心理念有多重要?就如1871年巴黎公社的失败。公社在对抗法国zf和普鲁士占领军的背景下成立,最初成功掌握了巴黎。然而,,加上对外部威胁的应对不足,公社最终被镇压,存在时间不足可怜的三个月。本文收录在我开源的《Java学习面试指南》中,一份覆盖Java程序员所需掌握的Java核心知识、面试重点。希望收到大家的 ⭐ Star ⭐支持。
26 0
你能不能手敲出Spring框架?
|
3天前
|
存储 安全 Java
详解 Spring Security:全面保护 Java 应用程序的安全框架
详解 Spring Security:全面保护 Java 应用程序的安全框架
12 1
|
4天前
|
Java 数据库连接 Android开发
SSM框架——使用MyBatis Generator自动创建代码
SSM框架——使用MyBatis Generator自动创建代码
11 2
|
6天前
|
Java 数据处理 数据库
Java一分钟之-Spring Batch:批量处理框架
【6月更文挑战第11天】Spring Batch是Spring家族的批处理框架,简化了批量处理任务的开发。它包含Job、Step、ItemReader、ItemProcessor和ItemWriter等核心组件,用于构建数据处理流程。本文讨论了批量处理中的常见问题,如内存溢出、事务管理和异常处理,并提供了相应的解决策略。通过添加相关依赖、定义Job和Steps,以及启动Job的示例代码,帮助开发者开始使用Spring Batch。了解其核心概念和最佳实践,能提升批量处理系统的效率和可靠性。
24 4
|
9天前
|
监控 数据管理 Java
智慧城管源码,基于微服务+java+springboot+vue+uniapp开发的城管综合执法系统源码
智慧城管执法系统利用微服务和Java技术提升城市管理水平,涵盖事件处理、投诉、处罚等功能,包含PC和APP源码。系统支持执法APP,便于领导随时随地审批,具备文书模板、地图定位、法规查询等功能。此外,执法办案系统通过监控视频分析事件,实现案件全程闭环管理,包括组织、案件、信用和执法队伍管理,以及法规库等基础支撑。系统旨在优化流程,提高数据管理和效率。
智慧城管源码,基于微服务+java+springboot+vue+uniapp开发的城管综合执法系统源码
|
10天前
|
监控 Java 数据库连接
Java一分钟之-Spring Boot:快速开发微服务
【6月更文挑战第7天】本文探讨了Spring Boot开发中的常见问题,包括起步依赖与版本管理、自动配置、启动类位置、日志配置、数据库连接、错误处理和Actuator监控。建议使用最新稳定版Spring Boot,通过`spring-boot-starter-parent`管理版本,理解自动配置原理,正确放置启动类,配置日志级别,准确设置数据库连接参数,自定义全局异常处理器,以及启用Actuator进行监控。不断学习和实践是应对各种问题的关键。
24 1
|
11天前
|
小程序 JavaScript Java
基于SpringBoot+Vue+uniapp微信小程序的外卖小程序的研究与开发的详细设计和实现
基于SpringBoot+Vue+uniapp微信小程序的外卖小程序的研究与开发的详细设计和实现
14 0