UJCMS 是一款基于 Java 的开源企业级网站内容管理系统(Java CMS),采用 SpringBoot、MyBatis、Spring Security、Vue3、Vite、ElementPlus 等前沿技术开发,支持 无头 CMS
架构。系统提供 模板 + 标签
和 Vue (React) + API
两种开发模式,适用于传统模板渲染和现代化前后端分离场景,为网站的建设、管理与维护提供高效、灵活、可靠的解决方案。
使用 Apache-2.0
开源协议,可免费用于商业用途。
- 演示站前台:https://demo.ujcms.com
- 演示站后台:https://demo.ujcms.com/cp/
- 官方网站:https://www.ujcms.com
- 官方文档:https://www.ujcms.com
- 安装包下载:https://www.ujcms.com/channels/downloads/
- JDK 11 或 JDK17
- MySQL 8.0 (5.7.22+)
- Tomcat 9.0 (Servlet 3.1+)
- Maven 3.6.3+
- 创建数据库。数据库名可为
ujcms
或其它任何名称。MySQL 字符集选utf8mb4
(不要使用utf8
,该字符集可能导致某些特殊字符出现乱码) - 无需执行 SQL 文件,程序启动时会自动创建表及初始化数据。以后程序升级同样不需要执行 SQL 升级脚本,程序启动时会判断当前软件版本及数据库表结构版本,自动进行数据库表结构升级
打开项目。在 IntelliJ IDEA 中点击 File
- Open
,选择项目文件夹(有 pom.xml
的文件夹)。会开始从 maven 服务器下载第三方 jar 包(如 spring 等),需要一定时间,请耐心等待。
连接数据库。打开 /src/main/resources/application.yaml
文件,根据实际情况修改以下配置:
spring.datasource.url
:数据库连接地址spring.datasource.username
:数据库用户名spring.datasource.password
:数据库密码
启动程序。可在左侧 Project
导航中找到 /src/main/java/com/ujcms/cms/Application
类,右键点击,选择 Run 'Application'
。也可直接点击右上角的绿色三角图标 (Run 'Application'
)。
首次运行程序,系统会自动创建数据库表和初始化数据库,需要一些时间,请耐心等待。直到出现类似 com.ujcms.cms.Application: Started Application in xxx seconds
信息,代表程序启动完成。
如程序无法正常编译,通常是因为 Maven 没有正确下载 jar 依赖包。可以尝试在 IntelliJ IDEA 的 Maven
窗口点击刷新按钮 Reload All Maven Projects
按钮,尝试重新下载 jar 依赖包,或者点击菜单 Build
- Rebuild Project
重新编译项目。
如首次使用 IntelliJ IDEA,没有配置 JDK,也会导致无法正常程序不能编译。可选中项目,点击 File
- Project Structure...
,在 Project Settings - Project
处,配置 Project SDK
。
程序启动时出现 LockException: Could not acquire change log lock
或 Waiting for changelog lock...
错误信息。解决办法:将数据库 databasechangeloglock
表中数据清空(请注意,不是 databasechangelog
表),或者删除数据库所有表(也可重建数据库),再次启动程序即可。原因:程序启动时会自动创建、升级数据库表结构,如果此时强行关闭程序,再次启动可能会出现这个问题。
程序启动时出现 Specified key was too long; max key length is 767 bytes
错误信息。解决办法:设置 MySQL 参数 innodb_large_prefix=ON
。原因:从 MySQL 5.7.7 开始,innodb_large_prefix
参数默认已设置为 ON
,但第三方面板或云服务商提供的 MySQL 可能修改默认配置。
前台地址:http://localhost:8080/,使用手机访问前台或者使用浏览器模拟手机访问前台,会自适应显示手机端的界面。如遇到前台页面没有样式的情况,则是因为没有部署在 Tomcat 的根目录。如前台首页地址类似为 http://localhost:8080/abc
,即代表部署在 /abc
目录下,没有部署在根目录。解决办法请参考下面 关于部署路径
部分内容。
后台地址:http://localhost:8080/cp/,用户名:admin,密码:password。后台前端基于 Vue 开发,如要修改后台界面,请另外下载 ujcms-cp
项目。
默认访问地址是 http://localhost:8080/
,如需修改域名、端口等内容,可分别到后台 配置 - 系统设置
和 配置 - 站点设置
中修改。修改域名、端口等信息后,需要在 内容 - 生成管理
处,点击 更新全部索引
,以免 全文检索
及 相关文章
的 url 地址依然为原域名、端口地址。
网站前台模板位于 /src/main/webapp/templates
目录,使用 Freemarker
作为模板引擎。通过修改模板文件,可以完全控制网站页面显示的内容。
使用 maven 进行打包 mvn package -P war
。会生成以下文件及文件夹:
target/ujcms-***.war
文件target/ujcms-***/
文件夹
如使用目录方式部署,可将 target/ujcms-***/
目录下文件复制到 tomcat 的 webapps/ROOT
目录下(请先删除原 tomcat/webapps
目录下所有内容)。目录结构大致如下:
webapps/ROOT/uploads
webapps/ROOT/templates
webapps/ROOT/WEB-INF
如使用 war 包部署,可将 ujcms-***.war
更名为 ROOT.war
(注意大小写),复制到 tomcat 的 webapps
目录下(请先删除原 tomcat/webapps 目录下所有文件夹)。复制完成后目录结构如下:
webapps/ROOT.war
war 部署要使用解压模式,tomcat 默认就是解压模式。如 tomcat 不会自动解压,请检查 tomcat/conf/server.xml
配置文件中 <Host ... unpackWARs="true"... >
配置项。
最后,检查 /WEB-INF/classes/application.yaml
文件中的数据库地址、用户名、密码相关配置是否正确。
使用 maven 进行打包 mvn package -P jar
。
将打包的 target/ujcms-***.jar
文件复制到部署目录,并新建文件夹 static
。
将 src/main/webapp
目录下所有文件复制到 static
目录下。目录结构大致如下:
- ujcms-***.jar
- static/WEB-INF/...
- static/templates/...
- static/uploads/...
- static/cp/...
在部署目录(即 ujcms-***.jar
所在目录)运行 java -jar ujcms-***.jar
命令,即可启动。
程序通常在部署在 Tomcat 根目录,首页访问地址类似于:
http://www.mysite.com/
http://localhost/
http://localhost:8080/
然而,在某些特殊情况下(例如在 Eclipse 中默认启动 Tomcat 时),应用程序可能会被部署到某个子路径下,此时首页的访问地址类似于:
http://www.mysite.com/ujcms/
http://localhost/ujcms/
http://localhost:8080/ujcms/
在这种情况下,网站前台可能会出现样式无法正常显示的问题。可以到后台 配置 - 全局设置
中设置 上下文路径
,例如 /ujcms
。其中斜杠 /
不能省略,ujcms
为部署路径。在开发环境中,部署路径通常为项目名称。
在开发环境中,建议尽量避免使用上下文路径,除非正式部署时也需要将应用程序部署到相同的路径下。否则,在开发环境中上传的图片在部署到正式环境时,可能无法正常显示。这是因为上传的图片地址会包含上下文路径信息(例如:/ujcms/uploads/...
)。
Eclipse 默认的 Tomcat 启动方式会将应用程序部署到一个特定的临时目录。因此,上传的图片(包括通过系统后台新增和修改的模板)会保存在这个临时部署目录中,而不是程序所在的目录。当修改了 Eclipse 中的源代码或文件时,系统会自动重新部署应用程序,导致之前上传的图片被清空。如果在开发环境中发现上传的图片突然丢失,很可能就是这个原因。
为了避免上述问题,强烈建议使用之前 启动程序
中介绍的方式启动程序。
程序在启动时会检查并升级数据库表结构版本,如果此时强行关闭程序,再次启动时会出现 LockException: Could not acquire change log lock
或 Waiting for changelog lock...
错误。如果您受此问题困扰,可在首次启动程序后(已成功创建表结构和初始数据),关闭表结构升级功能。
打开 /src/main/resources/application.yaml
文件,修改以下选项:
# 关闭 liquibase 的表结构升级功能
spring.liquibase.enabled: false
# 关闭 flowable 的表结构升级功能
flowable.database-schema-update: none
# 关闭执行初始化脚本
ujcms.data-sql-enabled: false
程序升级时,需重新开启以上配置,否则数据库表结构无法自动升级。
如果在 Windows 环境使用 MySQL,且以后需要迁移到 Linux 环境的 MySQL,建议将 Windows 环境的 MySQL 配置为表名大小写敏感模式。
因为 Linux 环境下 MySQL 的表名是大小写敏感的;而在 Windows 环境下 MySQL 表名大小写不敏感,且会自动把大写的表名改为小写的表名。从 Windows 向 Linux 迁移数据时,本为大写表名的成为了小写表名,导致程序出错。需要手动把小写表名改回大写表名,费时费力且容易出错。
UJCMS 系统的表名都为小写,不管在 Window 还是 Linux 下都没有问题,但第三方的类库(如 Liquibase、Flowable、Quartz 等)创建的表则为大写表名。所以 Windows 环境下也把 MySQL 设置成表名大小写敏感,有利以后迁移数据。
可修改 MySQL 配置文件 my.ini
:
[mysqld]
# Windows 下表名也区分大小写,与 Linux 一致。
lower_case_table_names=2
此配置必须在 MySQL 初始化之前设置。一旦 MySQL 已经启动或初始化,再修改该配置,MySQL 将无法再次启动。
迁移数据库时,需要将表结构和数据一起迁移。不可只迁移表结构,而不迁移数据。这会导致 Liquibase 重复建表,导致报错。
如果只想迁移表结构,则完全不用迁移。程序在连接到一个空数据库时,会自动创建表结构和插入初始化数据。
- src
- main
- java
- com/ujcms/cms
- core
- domain:实体类
- generator:生成功能(包括静态页生成,全文索引生成)
- listener:监听类(包括数据删除的监听)
- lucene:全文检索功能
- mapper:MyBatis Mapper Java 文件
- security:安全相关功能
- service:服务层功能
- support:各种支持类
- web
- api:前台 API 接口
- backendapi:后台 API 接口
- directive:前台 Freemarker 自定义标签
- frontend:前台页面 Controller
- support:Web 支持类(包括 web 拦截器等)
- ContextConfig.java:Context 配置类
- LuceneConfig.java:全文索引配置类
- ShiroConfig.java:Shiro 安全配置类
- TaskExecutorConfig.java:任务执行器配置类
- Application.java 启动类
- core
- com/ujcms/util:公共工具类
- com/ujcms/cms
- resources
- com/ujcms/cms/core/mapper:MyBatis Mapper XML 配置文件。
- db
- changelog:数据库表结构更新日志文件。
- data.mysql.sql:数据库初始化数据 SQL 脚本。
- application.yaml:程序配置文件。包括数据库 URL、数据库用户名、数据库密码等信息。
- messages.properties:国际化资源文件。
- webapp:
- cp:后台前端页面。
- templates:网站前台模板。
- uploads:用户上传文件。
- WEB-INF/lucene:全文检索索引文件。
- java
- main
- .editorconfig:设置编辑器文件的格式,如缩进方式、最大行数等。
- .gitignore:设置不需要提交到 git 管理的文件和目录。
- CHANGELOG.md:版本更新日志。
- LICENSE:许可协议。
- gulpfile.js:前台构建文件。具有拷贝 jquery、bootstrap 等文件至前台模板目录
/src/main/webapp/template/1/default/_files
的功能。 - package.json:前台模板依赖的 js、css 组件,如 jquery、bootstrap 等。
- pom.xml:Maven 配置文件。
QQ 交流群:626599871