spring-boot-demo README

The project's README from github.com/xkcoding/spring-boot-demo. As one markdown file: README.md.

Spring Boot Demo

Travis-CI Codacy author JDK Spring Boot LICENSE

star star star

中文 | English

项目简介

spring boot demo 是一个用来深度学习并实战 spring boot 的项目，目前总共包含 66 个集成demo，已经完成 55 个。

该项目已成功集成 actuator(监控)、admin(可视化监控)、logback(日志)、aopLog(通过AOP记录web请求日志)、统一异常处理(json级别和页面级别)、freemarker(模板引擎)、thymeleaf(模板引擎)、Beetl(模板引擎)、Enjoy(模板引擎)、JdbcTemplate(通用JDBC操作数据库)、JPA(强大的ORM框架)、mybatis(强大的ORM框架)、通用Mapper(快速操作Mybatis)、PageHelper(通用的Mybatis分页插件)、mybatis-plus(快速操作Mybatis)、BeetlSQL(强大的ORM框架)、upload(本地文件上传和七牛云文件上传)、redis(缓存)、ehcache(缓存)、email(发送各种类型邮件)、task(基础定时任务)、quartz(动态管理定时任务)、xxl-job(分布式定时任务)、swagger(API接口管理测试)、security(基于RBAC的动态权限认证)、SpringSession(Session共享)、Zookeeper(结合AOP实现分布式锁)、RabbitMQ(消息队列)、Kafka(消息队列)、websocket(服务端推送监控服务器运行信息)、socket.io(聊天室)、ureport2(中国式报表)、打包成war文件、集成 ElasticSearch(基本操作和高级查询)、Async(异步任务)、集成Dubbo(采用官方的starter)、MongoDB(文档数据库)、neo4j(图数据库)、docker(容器化)、JPA多数据源、Mybatis多数据源、代码生成器、GrayLog(日志收集)、JustAuth(第三方登录)、LDAP(增删改查)、动态添加/切换数据源、单机限流(AOP + Guava RateLimiter)、分布式限流(AOP + Redis + Lua)、ElasticSearch 7.x(使用官方 Rest High Level Client)、HTTPS、Flyway(数据库初始化)、UReport2(中国式复杂报表)。

如果大家还有想要集成的demo，也可在 issue 里提需求。我会额外添加在 TODO 列表里。✊

分支介绍

开发环境

运行方式

提示：如果是 fork 的朋友，同步代码的请参考：https://xkcoding.com/2018/09/18/how-to-update-the-fork-project.html

  1. git clone https://github.com/xkcoding/spring-boot-demo.git
  2. 使用 IDEA 打开 clone 下来的项目
  3. 在 IDEA 中 Maven Projects 的面板导入项目根目录下 的 pom.xml 文件
  4. Maven Projects 找不到的童鞋，可以勾上 IDEA 顶部工具栏的 View -> Tool Buttons ，然后 Maven Projects 的面板就会出现在 IDEA 的右侧
  5. 找到各个 Module 的 Application 类就可以运行各个 demo 了
  6. 注意：每个 demo 均有详细的 README 配套，食用 demo 前记得先看看哦~
  7. 注意：运行各个 demo 之前，有些是需要事先初始化数据库数据的，亲们别忘记了哦~

项目趋势

Stargazers over time

其他

团队纳新

组内招人啦，HC 巨多，Base 杭州，感兴趣的小伙伴，查看 岗位详情

开源推荐

11628591293_.pic_hd

开发计划

查看 TODO 文件

各 Module 介绍

Module 名称 Module 介绍
demo-helloworld spring-boot 的一个 helloworld
demo-properties spring-boot 读取配置文件中的内容
demo-actuator spring-boot 集成 spring-boot-starter-actuator 用于监控 spring-boot 的启动和运行状态
demo-admin-client spring-boot 集成 spring-boot-admin 来可视化的监控 spring-boot 程序的运行状态，可以与 actuator 互相搭配使用，客户端示例
demo-admin-server spring-boot 集成 spring-boot-admin 来可视化的监控 spring-boot 程序的运行状态，可以与 actuator 互相搭配使用，服务端示例
demo-logback spring-boot 集成 logback 日志
demo-log-aop spring-boot 使用 AOP 切面的方式记录 web 请求日志
demo-exception-handler spring-boot 统一异常处理，包括2种，第一种返回统一的 json 格式，第二种统一跳转到异常页面
demo-template-freemarker spring-boot 集成 Freemarker 模板引擎
demo-template-thymeleaf spring-boot 集成 Thymeleaf 模板引擎
demo-template-beetl spring-boot 集成 Beetl 模板引擎
demo-template-enjoy spring-boot 集成 Enjoy 模板引擎
demo-orm-jdbctemplate spring-boot 集成 Jdbc Template 操作数据库，并简易封装通用 Dao 层
demo-orm-jpa spring-boot 集成 spring-boot-starter-data-jpa 操作数据库
demo-orm-mybatis spring-boot 集成原生mybatis，使用 mybatis-spring-boot-starter 集成
demo-orm-mybatis-mapper-page spring-boot 集成通用Mapper和PageHelper，使用 mapper-spring-boot-starter 和 pagehelper-spring-boot-starter 集成
demo-orm-mybatis-plus spring-boot 集成 mybatis-plus，使用 mybatis-plus-boot-starter 集成，集成 BaseMapper、BaseService、ActiveRecord 操作数据库
demo-orm-beetlsql spring-boot 集成 beetl-sql，使用 beetl-framework-starter 集成
demo-upload spring-boot 文件上传示例，包含本地文件上传以及七牛云文件上传
demo-cache-redis spring-boot 整合 redis，操作redis中的数据，并使用redis缓存数据
demo-cache-ehcache spring-boot 整合 ehcache，使用 ehcache 缓存数据
demo-email spring-boot 整合 email，包括发送简单文本邮件、HTML邮件（包括模板HTML邮件）、附件邮件、静态资源邮件
demo-task spring-boot 快速实现定时任务
demo-task-quartz spring-boot 整合 quartz，并实现对定时任务的管理，包括新增定时任务，删除定时任务，暂停定时任务，恢复定时任务，修改定时任务启动时间，以及定时任务列表查询，提供前端页面
demo-task-xxl-job spring-boot 整合xxl-job，并提供绕过 xxl-job-admin 对定时任务的管理的方法，包括定时任务列表，触发器列表，新增定时任务，删除定时任务，停止定时任务，启动定时任务，修改定时任务，手动触发定时任务
demo-swagger spring-boot 集成原生的 swagger 用于统一管理、测试 API 接口
demo-swagger-beauty spring-boot 集成第三方 swagger swagger-bootstrap-ui 美化API文档样式，用于统一管理、测试 API 接口
demo-rbac-security spring-boot 集成 spring security 完成基于RBAC权限模型的权限管理，支持自定义过滤请求，动态权限认证，使用 JWT 安全认证，支持在线人数统计，手动踢出用户等操作
demo-rbac-shiro spring-boot 集成 shiro 实现权限管理
待完成
demo-session spring-boot 集成 Spring Session 实现Session共享、重启程序Session不失效
demo-oauth spring-boot 实现 oauth 服务器功能，实现授权码机制
待完成
demo-social spring-boot 集成第三方登录，集成 justauth-spring-boot-starter 实现QQ登录、GitHub登录、微信登录、谷歌登录、微软登录、小米登录、企业微信登录。
demo-zookeeper spring-boot 集成 Zookeeper 结合AOP实现分布式锁
demo-mq-rabbitmq spring-boot 集成 RabbitMQ 实现基于直接队列模式、分列模式、主题模式、延迟队列的消息发送和接收
demo-mq-rocketmq spring-boot 集成 RocketMQ，实现消息的发送和接收
待完成
demo-mq-kafka spring-boot 集成 kafka，实现消息的发送和接收
demo-websocket spring-boot 集成 websocket，后端主动推送前端服务器运行信息
demo-websocket-socketio spring-boot 使用 netty-socketio 集成 websocket，实现一个简单的聊天室
demo-ureport2 spring-boot 集成 ureport2 实现复杂的自定义的中国式报表
待完成
demo-uflo spring-boot 集成 uflo 快速实现轻量级流程引擎
待完成
demo-urule spring-boot 集成 urule 快速实现规则引擎
待完成
demo-activiti spring-boot 集成 activiti 7 流程引擎
待完成
demo-async spring-boot 使用原生提供的异步任务支持，实现异步执行任务
demo-war spring-boot 打成 war 包的配置
demo-elasticsearch spring-boot 集成 ElasticSearch，集成 spring-boot-starter-data-elasticsearch 完成对 ElasticSearch 的高级使用技巧，包括创建索引、配置映射、删除索引、增删改查基本操作、复杂查询、高级查询、聚合查询等
demo-dubbo spring-boot 集成 Dubbo，分别为公共模块 spring-boot-demo-dubbo-common、服务提供方spring-boot-demo-dubbo-provider、服务调用方spring-boot-demo-dubbo-consumer
demo-mongodb spring-boot 集成 MongoDB，使用官方的 starter 实现增删改查
demo-neo4j spring-boot 集成 Neo4j 图数据库，实现一个校园人物关系网的demo
demo-docker spring-boot 容器化
demo-multi-datasource-jpa spring-boot 使用JPA集成多数据源
demo-multi-datasource-mybatis spring-boot 使用Mybatis集成多数据源，使用 Mybatis-Plus 提供的开源解决方案实现
demo-sharding-jdbc spring-boot 使用 sharding-jdbc 实现分库分表，同时ORM采用 Mybatis-Plus
demo-tio spring-boot 集成 tio 网络编程框架
待完成
demo-grpc spring-boot 集成grpc，配置tls/ssl，参见ISSUE#5
待完成
demo-codegen spring-boot 集成 velocity 模板技术实现的代码生成器，简化开发
demo-graylog spring-boot 集成 graylog 实现日志统一收集
demo-sso spring-boot 集成 SSO 单点登录，参见 ISSUE#12
待完成
demo-ldap spring-boot 集成 LDAP，集成 spring-boot-starter-data-ldap 完成对 Ldap 的基本 CURD操作, 并给出以登录为实战的 API 示例，参见 ISSUE#23，感谢 @fxbin
demo-dynamic-datasource spring-boot 动态添加数据源、动态切换数据源
demo-ratelimit-guava spring-boot 使用 Guava RateLimiter 实现单机版限流，保护 API
demo-ratelimit-redis spring-boot 使用 Redis + Lua 脚本实现分布式限流，保护 API
demo-https spring-boot 集成 HTTPS
demo-elasticsearch-rest-high-level-client spring boot 集成 ElasticSearch 7.x 版本，使用官方 Rest High Level Client 操作 ES 数据
demo-flyway spring boot 集成 Flyway，项目启动时初始化数据库表结构，同时支持数据库脚本版本控制
demo-ureport2 spring boot 集成 Ureport2，实现中国式复杂报表设计

特别感谢

License

MIT

Copyright (c) 2018 Yangkai.Shen

spring-boot-demo (xkcoding/spring-boot-demo)

Searching Database…

34.1K ·GitHub
Spring-boot-demo
What is this?A large collection of hands-on Spring Boot demos: 66 planned integration modules (55 finished) covering ORM, caching, messaging, security, databases, logging and more, meant for learning Spring Boot by example.
Is this one app or a bunch of separate modules?It's a multi-module Maven project where each folder (demo-xxx) is an independent, runnable Spring Boot module demonstrating one specific integration.
How do I get a demo running?Clone the repo, open it in IntelliJ IDEA, import the root pom.xml via the Maven Projects panel, then find the Application class inside the module you want and run it directly.
What do I need installed before trying the demos?JDK 1.8+, Maven 3.5+, IntelliJ IDEA Ultimate 2018.2+ with the Lombok plugin, and MySQL 5.7+ for the database-backed demos.
Are all 66 demos actually finished and ready to run?No, several modules are explicitly marked '待完成' (not yet done), like demo-rbac-shiro, demo-oauth, demo-mq-rocketmq, demo-ureport2, demo-sso and a few others, and some demos require pre-initializing database data before running.
Who is this aimed at?Spring Boot learners who want runnable, isolated examples for specific integrations (ORM, cache, MQ, security, etc.) rather than production-ready boilerplate.
Which branch should I use, master or v-1.5.x?Use master, which targets Spring Boot 2.1.0.RELEASE; the older v-1.5.x branch (Spring Boot 1.5.8.RELEASE) is no longer actively maintained and new content is being added to master instead.
What kinds of integrations are covered?Everything from ORM (JPA, MyBatis, MyBatis-Plus), caching (Redis, Ehcache), messaging (RabbitMQ, Kafka, RocketMQ), search (Elasticsearch), NoSQL (MongoDB, Neo4j), security (Spring Security RBAC, LDAP, JustAuth third-party login), monitoring (Actuator, Spring Boot Admin), scheduled tasks (Quartz, XXL-Job), WebSocket, Docker, Dubbo, sharding-jdbc, and more.
Does each module come with its own documentation?Yes, every demo module has its own detailed README explaining how to run and use that specific integration.
What are similar projects?SpringBoot-Labs, mall, spring-boot-examples, mall-swarm, SpringAll, springboot-learning-example, mall-learning, newbee-mall
Which topics is it in?mybatis, demo, cache, spring, kafka, spring-boot, elasticsearch, mongodb, microservices, mysql, redis, security-tools
Creator
xkcoding
Size
13.9 MB
Stars
34.1K
Updated
CommitSep 02
Age
8y
Commits · 90 Days