29 Star 48 Fork 24

Evan / wow-note-spring

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

wow-note 个人云笔记

本仓库为后端仓库,需要了解前端仓库请🍧https://gitee.com/uyevan/wow-note-react

您也可以在线预览成品🎉http://note.jfkj.xyz

项目简介 👨‍💻

Wow-note 个人云笔记项目是专门用来在线 存储分享 个人笔记文档的软件;使用者可以快速地进行创建文件夹或笔记等操作,也可以对其进行 分享 操作,以便更多人查看与利用此分享者笔记。开发此软件的根本目的是对个人以前所学的技术进行一个综合的总结,无论使在以前在学校教过或自学过的相关技术进行一个打捞和评估;其次是本项目可能会作为我的毕设项目,虽然我写过很多项目(UY云,UyClub工具箱,乐应软件库...)但无论从技术层面,开发成本和难度上来看 wow-note 这项目都比这些小项目复杂得多。
wow-note项目后端是基于 SpringCloud 微服务方案扩展;前端是基于 NextJS(基于React的服务端渲染框架) 框架进行扩展。开发流程就是 设计,边编码边测试,部署,虽然不能说特别牛x,但对于我个人而言从设计到现在意义非凡,毕竟现在满脑子各种离谱Bug,如果对你有帮助不妨给个Star。项目简介

项目架构 🪜

项目架构图

服务列表 🛎️

服务列表

功能特性 🎉

  • JWT用户认证:跟大部分项目一样,我也选择了 JWT 用户认证策略,使用的技术是Auth0。对所有在 note-config 中配置的验证用户接口进行令牌验证以便提供安全服务。
  • Nacos服务注册中心:没有使用 Service RegisTration 是因为Nacos提供了更简洁更快速的上线方案,同时还提供了 配置中心 ,通过把所有服务注册到Nacos服务中,以便在业务上使用服务之间通讯以及启动多个服务实现负载均衡。
  • Nacos配置中心:理由跟注册中心一样,所有没有使用 Spring Cloud Config ;通过Nacos配置中心可以无感刷新应用Application配置,无需重启服务等。
  • 数据存储:项目中使用到了 MySQL,MongoDB,Redis 等三个数据库,在不同的业务需求上使用了不同特性的数据库实现方案。如用户服务中使用到了MySQL与Redis;笔记服务中使用到了MongoDB;分享服务中使用到了Redis;虽然都是最基础的利用多个数据库,但在不同的业务上使用不同的数据库就能高效实现数据存储与操作。
  • RabbitMQ延迟消息:note-services服务向其他客户模块提供日志存储服务,客户模块只需标记一个注解;当 AOP进行注解校验 ,符合则获取相关日志信息发送到MQ服务,核心服务进行日志的记录。
  • Sentinel服务熔断与流控:当对标记Sentinel资源的接口进行相应的熔断(如 下游无法响应、响应过长 等)与流控(如 刷IP、恶意请求 等)操作,使得保证服务的可靠性与安全性。
  • Minio对象存储:OSS存储方案使用了Minio,主要原因有: 部署简单 + 免费 + 功能全面
  • RPC通信:本项目中我使用了SpringCloud Feign作为服务间通信方案,并使用 key 来校验非法访问;以及使用 LoadBalanced 进行负载均衡,使得服务可靠性提升一个等级。

环境要求 ✅

Java https://www.java.com

java version "19.0.2" 2023-01-17
Java(TM) SE Runtime Environment (build 19.0.2+7-44)
Java HotSpot(TM) 64-Bit Server VM (build 19.0.2+7-44, mixed mode, sharing)

Maven https://maven.apache.org

Apache Maven 3.9.0
OS name: "windows 11", version: "10.0", arch: "amd64", family: "windows"

Nacos https://nacos.io

Nacos 2.2.3

MySQL https://www.mysql.com

+-----------+
| VERSION() |
+-----------+
| 5.7.26 |
+-----------+

MongoDB https://www.mongodb.com

"version": "6.0.5",
"allocator": "tcmalloc",
"distmod": "windows",
"distarch": "x86_64",
"target_arch": "x86_64"

Redis https://redis.io

Redis server v=5.0.14.1
malloc=jemalloc-5.2.1-redis
bits=64

Docker https://www.docker.com

Cloud integration: v1.0.35+desktop.5
Version: 24.0.6
API version: 1.43
Go version: go1.20.7
OS/Arch: windows/amd64

其他服务

其他服务

技术栈 🍵

  • SpringCloud(GateWay、FeignRPC、Gruid)
  • SpringBoot
  • Nacos(Config、Registry)
  • MySQL
  • MP
  • MongoDB
  • Redis
  • Docker
  • RabbitMQ
  • Minio
  • Sentinel

快速开始 🔛

我首先是在电脑(Windows11)本地进行开发,然后通过Docker打包镜像,再放到服务器进行部署的,可以通过拉取本地进行调试,也可以通过Docker进行拉去调试。

💻 本地拉去运行

  • 环境配置:配置本地 Java,MySQL,MongoDB,Redis,Nacos,RabbitMQ,Sentinel,Minio 环境;
  • 拉取项目:git clone https://gitee.com/uyevan/wow-note-spring.git
  • 应用配置:进入每个应用模块的 Application.yml 更改相应的配置,如应用端口,Nacos注册配置,数据库配置与调试开关等等;提示:你也可以选择在Nacos中创建一个服务配置
  • 运行项目:可以在IDEA中启动项目了;你也可以 mvn clean package 打包,再通过 java -jar target/note-user.jar 运行项目;启动前确保Nacos服务注册已经配置并且正常启动了Nacos服务;每个模块都需要单独打包启动;

🦣 拉去镜像运行

  • 环境配置:无论你是什么系统,要确保 Docker 环境并且正常启动;并且你要保证有足够空间,因为总共需要拉去五个镜像,因为国内无法访问DockerHub,所以我这里使用了阿里云镜像仓库服务(个人免费),无论哪个只要有Docker环境即可;
  • 拉去镜像:docker pull registry.cn-shenzhen.aliyuncs.com/wow-note-spring/wow-note-note-user:latest
  • 运行镜像:docker run -d -p 8081:8081 --name wow-note-user registry.cn-shenzhen.aliyuncs.com/wow-note-spring/wow-note-note-user:latest
  • 运行测试:可以调试一下相关的接口来验证是否正常启动;提示:这里我举例一个用户服务模块,您需要拉去你要运行的所有服务模块(笔记wow-note-note-notes/分享wow-note-note-share/网关wow-note-note-gateway)再运行前端,否则前端会报 Error 错误;

项目结构 🗃️

🐝 如下是用户服务模块的主要结构,我分结构比较细,已于后期维护项目时好理解,具体可以看仓库;主要结构如下:

└─note-user
├─src
│ ├─main
│ │ ├─java
│ │ │ └─com
│ │ │ └─note
│ │ │ └─user
│ │ │ ├─config
│ │ │ ├─constants
│ │ │ ├─controller
│ │ │ ├─dao
│ │ │ │ ├─impl
│ │ │ │ └─mapper
│ │ │ ├─domain
│ │ │ ├─dto
│ │ │ ├─enums
│ │ │ ├─interceptor
│ │ │ ├─pojo
│ │ │ ├─service
│ │ │ │ └─impl
│ │ │ ├─util
│ │ │ └─vo
│ │ └─resources
│ │ └─mapper

🗃️ 其他模块根用户模块结构类似,这就不都放出来了;剩余模块如下:

├─note-common 公用模块
├─note-services 核心服务
├─note-config 配置中心
├─note-gateway 网关中心
├─note-user 用户服务模块
├─note-tag 标签服务模块
├─note-comment 评论服务模块
├─note-notes 笔记服务模块
├─note-share 分享服务模块

项目预览 💻

NextUI是支持全段自定义适配的,一下是电脑端的预览结果,手机端不分上下; 主页 文档中心 笔记编辑 分享中心 分享查看

其他说明 🤥

本项目是我学习过程中写出的一个项目,写的项目也一般般,我的技术也一般般,刚好都一般般。如果对你有帮助可以给个 Star 噢!如果你觉得还有可优化的地方可以 Pull 到仓库,欢迎你来参与~

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2024 evan Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

📚基于SpringCloud,React框架的下一代个人云笔记项目后端. 展开 收起
Java 等 2 种语言
Apache-2.0
取消

发行版 (1)

全部

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/uyevan/wow-note-spring.git
git@gitee.com:uyevan/wow-note-spring.git
uyevan
wow-note-spring
wow-note-spring
master

搜索帮助