开源项目TARZAN-NAV | 基于springboot的现代化导航网站系统

た入场券 2024-04-22 15:27 68阅读 0赞

## TARZAN-NAV 导航网站 ##

一个基于 Spring Boot、MyBatis-Plus、h2database、ehcache、Docker、websocket等技术栈实现的导航网站系统，采用主流的互联网技术架构、全新的UI设计、支持一键源码部署，拥有完整的仪表板、导航管理，用户管理、评论管理、友情链接、公告管理、运维管理等，代码完全开源，没有任何二次封装，是一个非常适合二次开发/实战的现代化导航项目? 。

### 我的博客 ###

1.  **JAVA OPC UA专栏**：[https://blog.csdn.net/weixin\_40986713/category\_12356608.html][https_blog.csdn.net_weixin_40986713_category_12356608.html]
2.  **AI绘画 | Stable diffusion**：[https://blog.csdn.net/weixin\_40986713/category\_12481790.html][https_blog.csdn.net_weixin_40986713_category_12481790.html]
3.  **java高级技术专栏**：[https://blog.csdn.net/weixin\_40986713/category\_10796066.html][https_blog.csdn.net_weixin_40986713_category_10796066.html]
4.  **java Selenium自动化爬虫**：[https://blog.csdn.net/weixin\_40986713/category\_12165790.html][https_blog.csdn.net_weixin_40986713_category_12165790.html]
5.  **java 推荐算法专栏**：[https://blog.csdn.net/weixin\_40986713/category\_12268014.html][https_blog.csdn.net_weixin_40986713_category_12268014.html]
6.  **Java视频图像处理专栏**：[https://blog.csdn.net/weixin\_40986713/category\_11109931.html][https_blog.csdn.net_weixin_40986713_category_11109931.html]

### 一、目标使命 ###

*  打造一个性能最好，在同等资源下，实现最大的用户并发数。
 *  部署简单，让技术小白也能部署使用
 *  增强用户体验，更好的UI交互，操作体验

### 二、项目介绍 ###

#### 项目演示 ####

##### 项目源码地址 #####

*  项目仓库（GitHub）：[https://github.com/taishan666/tarzan-navigation][https_github.com_taishan666_tarzan-navigation]
 *  项目仓库（码云）：[https://gitee.com/taisan/tarzan-navigation][https_gitee.com_taisan_tarzan-navigation]

##### 前台社区系统 #####

*  项目演示地址：[http://82.157.61.108/][http_82.157.61.108]

![在这里插入图片描述][962f75c628fa4209bc6ef6a16b1f1fde.png]

##### 后台社区系统 #####

*  项目演示地址：[http://82.157.61.108/admin][http_82.157.61.108_admin]

![在这里插入图片描述][970baf10c6f24f01a1c1d694d18d7f4e.png]

##### 代码展示 #####

![在这里插入图片描述][cb7d2340816c40bf871a00d342436ca5.png]

#### 架构图 ####

![在这里插入图片描述][eee1ec985bd244ecb8cc4abd973709f9.png]

##### 环境配置说明 #####

安装 jdk1.8+

在application-dev.yml 或者application-prod.yml文件中修改 自己的邮箱配置，其他保持保持默认接口

##### 配置文件说明 #####

*  resources
    
     *  application.yml: 主配置文件入口
     *  application-dev.yml: 开发环境配置
     *  application-prod.yml: 生成环境配置
     *  ehcache.xml 本地缓存配置
     *  logback-spring.xml: 日志打印相关配置文件

#### 技术选型 ####

后端技术栈

<table> 
 <thead> 
  <tr> 
   <th align="center">技术</th> 
   <th>说明</th> 
   <th>官网</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">Spring &amp; SpringMVC</td> 
   <td>Java全栈应用程序框架和WEB容器实现</td> 
   <td><a href="https://spring.io/" rel="nofollow">https://spring.io/</a></td> 
  </tr> 
  <tr> 
   <td align="center">SpringBoot</td> 
   <td>Spring应用简化集成开发框架</td> 
   <td><a href="https://spring.io/projects/spring-boot" rel="nofollow">https://spring.io/projects/spring-boot</a></td> 
  </tr> 
  <tr> 
   <td align="center">mybatis</td> 
   <td>数据库orm框架</td> 
   <td><a href="https://mybatis.org" rel="nofollow">https://mybatis.org</a></td> 
  </tr> 
  <tr> 
   <td align="center">mybatis-plus</td> 
   <td>数据库orm框架</td> 
   <td><a href="https://baomidou.com/" rel="nofollow">https://baomidou.com/</a></td> 
  </tr> 
  <tr> 
   <td align="center">ehcache</td> 
   <td>内存数据存储</td> 
   <td><a href="https://www.ehcache.org/" rel="nofollow">https://www.ehcache.org/</a></td> 
  </tr> 
  <tr> 
   <td align="center">docker</td> 
   <td>应用容器引擎</td> 
   <td><a href="https://www.docker.com" rel="nofollow">https://www.docker.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">hikariCP</td> 
   <td>数据库连接</td> 
   <td><a href="https://github.com/brettwooldridge/HikariCP" rel="nofollow">https://github.com/brettwooldridge/HikariCP</a></td> 
  </tr> 
  <tr> 
   <td align="center">oss</td> 
   <td>对象存储</td> 
   <td><a href="https://help.aliyun.com/document_detail/31883.html" rel="nofollow">https://help.aliyun.com/document_detail/31883.html</a></td> 
  </tr> 
  <tr> 
   <td align="center">https</td> 
   <td>证书</td> 
   <td><a href="https://letsencrypt.org/" rel="nofollow">https://letsencrypt.org/</a></td> 
  </tr> 
  <tr> 
   <td align="center">jwt</td> 
   <td>jwt登录</td> 
   <td><a href="https://jwt.io" rel="nofollow">https://jwt.io</a></td> 
  </tr> 
  <tr> 
   <td align="center">lombok</td> 
   <td>Java语言增强库</td> 
   <td><a href="https://projectlombok.org" rel="nofollow">https://projectlombok.org</a></td> 
  </tr> 
  <tr> 
   <td align="center">guava</td> 
   <td>google开源的java工具集</td> 
   <td><a href="https://github.com/google/guava" rel="nofollow">https://github.com/google/guava</a></td> 
  </tr> 
  <tr> 
   <td align="center">thymeleaf</td> 
   <td>html5模板引擎</td> 
   <td><a href="https://www.thymeleaf.org" rel="nofollow">https://www.thymeleaf.org</a></td> 
  </tr> 
  <tr> 
   <td align="center">swagger</td> 
   <td>API文档生成工具</td> 
   <td><a href="https://swagger.io" rel="nofollow">https://swagger.io</a></td> 
  </tr> 
  <tr> 
   <td align="center">hibernate-validator</td> 
   <td>验证框架</td> 
   <td><a rel="nofollow">hibernate.org/validator/</a></td> 
  </tr> 
  <tr> 
   <td align="center">quick-media</td> 
   <td>多媒体处理</td> 
   <td><a href="https://github.com/liuyueyi/quick-media" rel="nofollow">https://github.com/liuyueyi/quick-media</a></td> 
  </tr> 
  <tr> 
   <td align="center">liquibase</td> 
   <td>数据库版本管理</td> 
   <td><a href="https://www.liquibase.com" rel="nofollow">https://www.liquibase.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">jackson</td> 
   <td>json/xml处理</td> 
   <td><a href="https://www.jackson.com" rel="nofollow">https://www.jackson.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">ip2region</td> 
   <td>ip地址</td> 
   <td><a href="https://github.com/zoujingli/ip2region" rel="nofollow">https://github.com/zoujingli/ip2region</a></td> 
  </tr> 
  <tr> 
   <td align="center">websocket</td> 
   <td>长连接</td> 
   <td><a href="https://docs.spring.io/spring/reference/web/websocket.html" rel="nofollow">https://docs.spring.io/spring/reference/web/websocket.html</a></td> 
  </tr> 
  <tr> 
   <td align="center">sensitive-word</td> 
   <td>敏感词</td> 
   <td><a href="https://github.com/houbb/sensitive-word" rel="nofollow">https://github.com/houbb/sensitive-word</a></td> 
  </tr> 
 </tbody> 
</table>

### 三、环境搭建 ###

#### 开发工具 ####

<table> 
 <thead> 
  <tr> 
   <th align="center">工具</th> 
   <th>说明</th> 
   <th>官网</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">IDEA</td> 
   <td>java开发工具</td> 
   <td><a href="https://www.jetbrains.com" rel="nofollow">https://www.jetbrains.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">Chrome</td> 
   <td>浏览器</td> 
   <td><a href="https://www.google.com/intl/zh-CN/chrome" rel="nofollow">https://www.google.com/intl/zh-CN/chrome</a></td> 
  </tr> 
  <tr> 
   <td align="center">Postman</td> 
   <td>API接口调试</td> 
   <td><a href="https://www.postman.com" rel="nofollow">https://www.postman.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">draw.io</td> 
   <td>流程图、架构图绘制</td> 
   <td><a href="https://www.diagrams.net/" rel="nofollow">https://www.diagrams.net/</a></td> 
  </tr> 
  <tr> 
   <td align="center">Axure</td> 
   <td>原型图设计工具</td> 
   <td><a href="https://www.axure.com" rel="nofollow">https://www.axure.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">navicat</td> 
   <td>数据库连接工具</td> 
   <td><a href="https://www.navicat.com" rel="nofollow">https://www.navicat.com</a></td> 
  </tr> 
  <tr> 
   <td align="center">DBeaver</td> 
   <td>免费开源的数据库连接工具</td> 
   <td><a href="https://dbeaver.io" rel="nofollow">https://dbeaver.io</a></td> 
  </tr> 
  <tr> 
   <td align="center">xshell</td> 
   <td>终端模拟软件</td> 
   <td><a href="https://www.xshell.com/zh/xshell/" rel="nofollow">https://www.xshell.com/zh/xshell/</a></td> 
  </tr> 
 </tbody> 
</table>

#### 开发环境 ####

<table> 
 <thead> 
  <tr> 
   <th align="center">工具</th> 
   <th align="left">版本</th> 
   <th>下载</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="center">jdk</td> 
   <td align="left">1.8+</td> 
   <td><a href="https://www.oracle.com/java/technologies/downloads/#java8" rel="nofollow">https://www.oracle.com/java/technologies/downloads/#java8</a></td> 
  </tr> 
  <tr> 
   <td align="center">maven</td> 
   <td align="left">3.4+</td> 
   <td><a href="https://maven.apache.org/" rel="nofollow">https://maven.apache.org/</a></td> 
  </tr> 
  <tr> 
   <td align="center">ali-oss</td> 
   <td align="left">3.15.1</td> 
   <td><a href="https://help.aliyun.com/document_detail/31946.html" rel="nofollow">https://help.aliyun.com/document_detail/31946.html</a></td> 
  </tr> 
  <tr> 
   <td align="center">git</td> 
   <td align="left">2.34.1</td> 
   <td><a href="http://github.com/" rel="nofollow">http://github.com/</a></td> 
  </tr> 
  <tr> 
   <td align="center">docker</td> 
   <td align="left">4.10.0+</td> 
   <td><a href="https://docs.docker.com/desktop/" rel="nofollow">https://docs.docker.com/desktop/</a></td> 
  </tr> 
  <tr> 
   <td align="center">let’s encrypt</td> 
   <td align="left">https证书</td> 
   <td><a href="https://letsencrypt.org/" rel="nofollow">https://letsencrypt.org/</a></td> 
  </tr> 
 </tbody> 
</table>

#### 搭建步骤 ####

##### 1. 环境准备 #####

首先准备好基础的开发环境，如

*  jdk/jre: 请安装jdk8+以上版本
 *  maven: 本项目基于maven作为项目管理工具，因此在启动之前请配置好maven相关环境
 *  git版本管理
 *  开发工具：建议idea，当然eclipse/vs也没有问题

##### 2. 项目启动 #####

当环境准备完毕之后，接下来就是下载项目，导入开发工具进行启动演示

###### 2.1 项目获取 ######

本项目所有源码开源，因此您可以在github/gitee上免费获取

**通过git方式拉取项目**

# Git clone
    git clone git@gitee.com:taisan/tarzan-navigation.git

**下载release包**

若希望从一个稳定的版本进行尝试，推荐在release页下载zip包，然后本机解压

*  [https://gitee.com/taisan/tarzan-navigation/releases][https_gitee.com_taisan_tarzan-navigation_releases]

###### 2.2 项目导入 ######

以IDEA开发工具为例

*  File -> Open
 *  选择第一步clone的项目工程

项目导入成功之后，会自动下载依赖、构建索引，此过程用时取决于您的机器性能+网速，通常会持续一段时间，请耐心等待。

如果发现项目 build 未成功或者无法运行 Java 程序，要立马检查一下自己 Intellij IDEA 中的 Maven 是否配置成功。

![在这里插入图片描述][1478ca425836417cbb0e88d87ec3d44d.png]

###### 2.3 配置修改 ######

在正式启动项目之前，还有几个前置步骤需要执行一下

###### 2.3.1 数据库准备 ######

本项目会使用数据库，因此在本机启动时，请先指定数据库；项目中默认的数据库名为 `paicoding`，可以通过修改配置文件中的`database.name`参数来替换为您喜欢的数据库名

数据库名配置: tarzan-navigation/src/main/resources/application.yml

spring:
      datasource:
        type: com.alibaba.druid.pool.DruidDataSource
        driverClassName: org.h2.Driver
        url:  jdbc:h2:file:${
        user.home}/.tarzan-nav/db/tarzan-nav;MODE=MYSQL
        username: root
        password: 123456
      mail:
        host: smtp.163.com
        username: vxhqqh@163.com
        password: TRXZYKQFHNZHOYMB
        default-encoding: UTF-8
        protocol: smtp
        properties:
          mail:
            smtp:
              auth: true # 启用SMTP认证
              starttls:
                enabled: true # 启用SMTP认证
                required: true # 必须采用加密链接

> 本项目提供了自动创建库表的功能，在项目启动之后，当库不存在时，会创建库；当表不存在时，会自动创建表，且会初始化一些测试数据

###### 2.3.2 数据库配置 ######

接下来我们需要做的就是设置数据库的相关连接配置

首先在进入之前，先简单了解一下配置，我们做了环境区分,在resources文件夹下，

*  dev: 本地开发环境
 *  prod: 生产环境

默认的环境选择是`dev`，可以通过下面两种方式进行环境切换

###### 2.4 启动 ######

接下来就可以直接启动项目了

进入启动类: `NavApplication`

![在这里插入图片描述][d41c41537b3b402bbc14a520878c23ca.png]

启动完毕之后，将会在控制台看到如下输出

![在这里插入图片描述][433355bd1c884c079b96bc727c027cee.png]

点击控制台中的链接进入首页, 默认首页为: [http://127.0.0.1:80][http_127.0.0.1_80]

### 许可证 ###

[Apache License 2.0][]

##### 技术交流&问题反馈 #####

联系QQ:1334512682 微信号：vxhqqh

[问题交流反馈平台][Link 1]

[https_blog.csdn.net_weixin_40986713_category_12356608.html]: https://blog.csdn.net/weixin_40986713/category_12356608.html
[https_blog.csdn.net_weixin_40986713_category_12481790.html]: https://blog.csdn.net/weixin_40986713/category_12481790.html
[https_blog.csdn.net_weixin_40986713_category_10796066.html]: https://blog.csdn.net/weixin_40986713/category_10796066.html
[https_blog.csdn.net_weixin_40986713_category_12165790.html]: https://blog.csdn.net/weixin_40986713/category_12165790.html
[https_blog.csdn.net_weixin_40986713_category_12268014.html]: https://blog.csdn.net/weixin_40986713/category_12268014.html
[https_blog.csdn.net_weixin_40986713_category_11109931.html]: https://blog.csdn.net/weixin_40986713/category_11109931.html
[https_github.com_taishan666_tarzan-navigation]: https://github.com/taishan666/tarzan-navigation
[https_gitee.com_taisan_tarzan-navigation]: https://gitee.com/taisan/tarzan-navigation
[http_82.157.61.108]: http://82.157.61.108/
[962f75c628fa4209bc6ef6a16b1f1fde.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/42b186bc37d3402983732ac7f94386e4.png
[http_82.157.61.108_admin]: http://82.157.61.108/admin
[970baf10c6f24f01a1c1d694d18d7f4e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/5e8e63a5f5c44bd09a530ba0fd879cbc.png
[cb7d2340816c40bf871a00d342436ca5.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/989e789a169b4156bd9c26261ed1bcd6.png
[eee1ec985bd244ecb8cc4abd973709f9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/9c612d34424548a880aaf048ecff8fdd.png
[https_gitee.com_taisan_tarzan-navigation_releases]: https://gitee.com/taisan/tarzan-navigation/releases
[1478ca425836417cbb0e88d87ec3d44d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/c030261a48524c74bb996aab342b515f.png
[d41c41537b3b402bbc14a520878c23ca.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/fa4829c3aec04b089bc5766aee298e80.png
[433355bd1c884c079b96bc727c027cee.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/22/d9cc46bc0b0b463e9c9add8c10cd88fd.png
[http_127.0.0.1_80]: http://127.0.0.1:80
[Apache License 2.0]: https://gitee.com/taisan/tarzan-navigation/edit/master/README.md
[Link 1]: https://support.qq.com/product/592558