# OSRS

**Repository Path**: BlueinLife/OSRS

## Basic Information

- **Project Name**: OSRS
- **Description**: Online Student Remark System
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 0
- **Created**: 2017-12-26
- **Last Updated**: 2023-05-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

交流QQ群：692247613
## 项目介绍
　　基于Spring+SpringMVC+Mybatis分布式敏捷开发系统架构，提供整套评价系统服务模块：班级管理、用户管理、考评管理、统计分析、个人中心等，支持服务治理、监控和追踪，努力为中小型企业打造全方位J2EE企业级开发解决方案。

### 组织结构
``` lua
src
|
main
|  |
|  java 
|  |
|  ├── com.tz --后台
|  |    ├── controller -- 框架控制层模块
|  |    ├── entity -- 项目实体类模块
|  |    ├── exception -- 自定义异常模块
|  |    ├── intercepter -- 拦截器模块
|  |    ├── listener -- 监听器模块
|  |    ├── mapper -- mapper模块
|  |    ├── service -- 业务层模块
|  |    └──util -- 工具类模块
|  ├── resources --配置
|  |         ├── applicationContext -- Spring配置
|  |         ├── dbConfig -- 数据库配置
|  |         ├── ehcache -- 缓存配置
|  |         ├── log4j -- lo4j配置
|  |         ├── mvc --Springmvc配置
|  |         ├── spy --p6spy配置
|  |         └── SqlMapConfig --Mybatis配置
|  |    
|  ├── webapp -- 前台
|   
test --测试类
```

### 技术选型

#### 后端技术:
技术 | 名称 | 官网
----|------|----
SpringMVC | MVC框架  | [http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc](http://docs.spring.io/spring/docs/current/spring-framework-reference/htmlsingle/#mvc)
MyBatis | ORM框架  | [http://www.mybatis.org/mybatis-3/zh/index.html](http://www.mybatis.org/mybatis-3/zh/index.html)
MyBatis Generator | 代码生成  | [http://www.mybatis.org/generator/index.html](http://www.mybatis.org/generator/index.html)
Log4J | 日志组件  | [http://logging.apache.org/log4j/1.2/](http://logging.apache.org/log4j/1.2/)
Maven | 项目构建管理  | [http://maven.apache.org/](http://maven.apache.org/)

#### 软件概述
1.目标
系统可以对项目经理、教师、班主任、市场招生人员等多部门的员工进行调查，调查信息从学员处采集，系统考虑到了并发操作，可以同时对多个班级的学员开启调查，在二期将实现更加智能化的附加功能，比如自动发送邮件、打印报表等。
2.功能
系统部署成功后，考评执行者进入系统，选择某个班级以及一个调查对象，该调查对象可以是该班级对应的pm或者班主任、咨询师等，然后开启一个调查，开启成功后，该班级的学员可以进入考评系统填写调查数据，对该调查对象进行考评，学员提交后，考评执行者关闭调查。Pmo进入系统后可以查看并审核这些调查记录，审核过后，班主任、调查员等调查对象可以登陆系统查看自己的调查结果。

#### 运行环境
a.	语言编译系统或汇编系统的名称及版本号；jdk8.0
b.	数据库管理系统的名称及版本号；Oracle 10.0
c.	其他必要的支持软件:tomcat 7.0

#### 开发工具:
- Oracle: 数据库
- Tomcat: 应用服务器
- Git: 版本管理
- IntelliJ IDEA: 开发IDE
- astah-community 建模工具

#### 开发环境：
- Jdk8+

## 开发指南:

- 1、本机安装Jdk8、Oracle 并**启动相关服务**，使用默认配置默认端口即可
- 2、克隆源代码到本地并打开，**推荐使用IntelliJ IDEA**，本地编译并安装到本地maven仓库

### 编译流程

maven编译安装pom.xml文件即可

war包项目：使用tomcat等web容器启动

### 框架规范约定

约定优于配置(convention over configuration)，此框架约定了很多编程规范，下面一一列举：

```

- service类，需要在叫名`service`的包下，并以`Service`结尾，如`xxxxxServiceImpl`

- controller类，需要在以`controller`结尾的包下，类名以Controller结尾，如`xxxxxController.java`。

- mapper.xml，需要在名叫`mapper`的包下，并以`Mapper.xml`结尾，如`xxxxxxMapper.xml`

- mapper接口，需要在名叫`mapper`的包下，并以`Mapper`结尾，如`xxxxxxMapper.java`

- 实体类，需要在名叫`entity`的包下，命名规则为数据表转驼峰规则，如`xxxxx.java`

- spring配置文件，命名规则为`applicationContext-*.xml`

- 类名：首字母大写驼峰规则；方法名：首字母小写驼峰规则；常量：全大写；变量：首字母小写驼峰规则，尽量非缩写

- springmvc配置加到对应模块的`mvc.xml`文件里

- 配置文件放到`src/main/resources`目录下

- 静态资源文件放到`src/main/webapp/resources`目录下

- jsp文件，需要在`/WEB-INF/jsp`目录下

- `RequestMapping`和返回物理试图路径的url尽量写全路径，如：`@RequestMapping("/manage")`、`return "/manage/index"`

- `RequestMapping`指定method


- 数据表命名为：`子系统`_`表`，如`osrs_Poll`

- 更多规范，参考[[阿里巴巴Java开发手册] http://git.oschina.net/shuzheng/zheng/attach_files

```

## 许可证

[拼命六人组专业许可](LICENSE "six six six six")