Skip to content

SericaLaw/vCampus

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

vCampus

一个没有用任何框架的原始app(屈服,真香)使用Hibernate ORM的Java App,前端采用Java FX编程,后端目前纯Java手撸是不会使用Spring的,不会使用Spring的。使用Java Socket进行前后端通信,使用Access数据库。

按照项目要求,目录结构如下组织:

路径 说明
vCampus/vCampusClient 前端
vCampus/vCampusClient/App.java 前端程序主入口
vCampus/vCampusClient/StageController.java 前端多页应用管理配置工具类
vCampus/vCampusClient/ViewController.java 前端Controller抽象类
vCampus/vCampusClient/***ViewController.java 前端ViewController类
vCampus/vCampusClient/***ViewFactory.java 前端视图工厂类
vCampus/vCampusServer 后端
vCampus/vCampusServer/annotation 后端注解定义
vCampus/vCampusServer/api 后端APIController
vCampus/vCampusServer/framework 后端核心框架
vCampus/vCampusServer/Program.java 后端服务器程序主入口类
vCampus/vCampusCore 前后端公用模块
vCampus/vCampusCore/data DBHelper工具类
vCampus/vCampusCore/models entity和viewmodel
vCampus/vCampusCore/util Api类和Logger工具类
vCampus/vCampusCore/web 基于Socket封装的前后端通信工具类
vCampus/third-party-lib 项目依赖
docs API文档
javadoc Javadoc文档
java-app-template-demo 一个采用MVC模式的Java示例程序
vCampus/vCampusServer/database 数据库

构想

前端采用MVC模式开发,如果你不清楚MVC模式的话,可以参考教程

前端中的视图层主要专注界面,要开发出一个大体的界面框架,方便代码复用。

通过调用后端接口,对数据库进行增删改查,并把结果返回给前端,前端需要相应地更新视图,或给出其他交互信息。

开发环境

编辑器:使用IntelliJ IDEA

maven相关:使用maven简单配置

关于git

如果你还不够熟悉git,可以查看这个教程

如果你使用git bash,下面有一些常用命令:

git clone git@github.com:SericaLaw/vCampus.git
git add . 
git status
git commit -m "comment"
git push origin master (or other branch)
git pull
git branch (a new branch)
git checkout (some other branch)

用Git进行多人协作的原则:每个人应明确自己的责任区,尽量避免提交时出现冲突;对自己的commit负责,先进行测试后再提交

apidoc

在仓库根目录打开终端,输入命令:

apidoc -i ./vCampus/vCampusServer/src/main/java/team/yummy/vCampus/server/api -o ./docs -t ./docs/src/template/

即可创建api文档。

资源列表

Java FX 文档

  1. 官方文档主页
  2. Java FX API文档
  3. Java FX CSS Reference
  4. Java FX FXML Reference
  5. Java FX中的数据绑定
  6. JavaFX Collections
  7. 一个不错的JavaFX Material Design库,我们的项目也将用到它:JFoenix
  8. JFoenix文档

规范

  1. 数据库命名规范
  2. CSS编码规范
  3. CSS BEM命名规范

UI设计参考

  1. 主程序
  2. 登录界面
  3. 什么都能找到(配色、图标、素材、UI灵感…)的设计导航

Java教程

  1. MVC设计模式

Git教程

  1. 廖雪峰