学成在线项目实战20天2018年

学成在线项目
1 项目功能架构
1.1 项目模块
功能模块名称
功能说明
门户
在首页、活动页、专题页等页面提供课程学习入口。
学习中心
学生登录学习中心在线学习课程。
社交系统
社交系统为老师和学生交流搭建沟通的平台，包括：问答系统、评论系统、论坛等，学生和老师通过问答系统提问问题、回答问题，通过评论系统对老师授课进行评论。
教学管理中心
教师登录教学管理中心进行课程管理、资源管理、考试管理等教学活动。
系统管理中心
系统管理员登录系统管理中心进行分类管理、运维管理等功能。
2 项目技术架构
2.1 项目模块
1 用户层
用户层描述了本系统所支持的用户类型包括：pc用户、app用户、h5用户。pc用户通过浏览器访问系统、app用户通过android、ios手机访问系统，H5用户通过h5页面访问系统。
CDN全称Content Delivery Network，即内容分发网络，本系统所有静态资源全部通过CDN加速来提高访问速度。系统静态资源包括：html页面、js文件、css文件、image图片、pdf和ppt及doc教学文档、video视频等。
3 负载均衡
系统的CDN层、UI层、服务层及数据层均设置了负载均衡服务，上图仅在UI层前边标注了负载均衡。 每一层的负载均衡会根据系统的需求来确定负载均衡器的类型，系统支持4层负载均衡+7层负载均衡结合的方式，4层负载均衡是指在网络传输层进行流程转发，根据IP和端口进行转发，7层负载均衡完成HTTP协议负载均衡及反向代理的功能，根据url进行请求转发。
4 UI层
UI层描述了系统向pc用户、app用户、h5用户提供的产品界面。根据系统功能模块特点
确定了UI层包括如下产品界面类型：
1）面向pc用户的门户系统、学习中心系统、教学管理系统、系统管理中心。
2）面向h5用户的门户系统、学习中心系统。
3）面向app用户的门户系统、学习中心系统未在上图标注，在app项目中有详细说明。
5 微服务层
微服务层将系统服务分类三类：前端服务、后端服务及系统服务。
前端服务：主要为学习用户提供学习服务。
后端服务：主要为管理用户提供教学管理服务。
系统服务：公共服务，为系统的所有微服务提供公共服务功能。
服务网关：提供服务路由、负载均衡、认证授权等服务。
6 数据层
数据层描述了系统的数据存储的内容类型，持久化的业务数据使用MySQL和MongoDB保存，其中MongoDB中主要保存系统日志信息。
消息队列：存储系统服务间通信的消息，本身提供消息存取服务，与微服务层的系统服务连接。
索引库：存储课程信息的索引信息，本身提供索引维护及搜索的服务，与微服务层的系统服务连接。
缓存：作为系统的缓存服务，存储课程信息、分类信息、用户信息等，与微服务层的所有服务连接。
文件存储：提供系统静态资源文件的分布式存储服务，文件存储服务器作为CDN服务器的数据来源，CDN上的静态资源将最终在文件存储服务器上保存多份。
流媒体服务：作为流媒体服务器，存储所有的流媒体文件。
7 外部系统接口
1）微信、QQ、微博登录接口，本系统和微信、QQ、微博系统对接，用户输入微信、QQ、微博的账号和密码即可登录本系统。
2）微信、QQ、微博分享接口，本系统和微信、QQ、微博系统对接，可直接将本系统的课程资源信息分享到微信、QQ、微博。
3）支付宝、微信、网银支付接口，本系统提供支付宝、微信、网银三种支付接口。
4）短信接口，本系统与第三方平台对接短信发送接口。
5）邮件接口，本系统需要连接第三方的smpt邮件服务器对外发送电子邮件。
6）微信公众号，本系统与微信公众号平台接口，用户通过微信公众号访问H5页面。
7）点播、直播，前期视频点播与直播采用第三方服务方式，本系统与第三方点、直播服务对接，对外提供视频点播与直播服务。
8）OSS存储 ，前期静态资源文件的存储采用第三方服务方式，本系统与第三方提供的OSS存储服务对接，将系统的静态资源文件存储到第三方提供的OSS存储服务器上。
9）CDN，本系统与第三方CDN服务对接，使用CDN加速服务来提高本系统的访问速度。
DevOps（英文Development和Operations的组合）是一组过程、方法与系统的统称，用于促进开发（应用程序/软件工程）、技术运营和质量保障（QA）部门之间的沟通、协作与整合。
本项目供了许多开发、运营、维护支撑的系统，包括：
Eureka服务治理中心：提供服务治理服务，包括：服务注册、服务获取等。
Spring Cloud Config服务配置管理中心：提供服务配置管理服务，包括：配置文件更新、配置文件下发等
Hystrix Dashboard服务熔断监控：监控熔断的请求响应时间、成功率等 。
Zipkin服务追踪监控：监控服务调用链路健康情况。
Jenkins持续集成服务：提供系统持续集成服务。
Git/GitLab代码管理服务:提供git代码管理服务。
ELK日志分析服务:提供elk日志分析服务，包括系统运行日志分析、告警服务。
Docker容器化部署服务：将本系统所有服务采用容器化部署方式。
Maven项目管理工具：提供管理项目所有的Java包依赖、项目工程打包服务。
2.2 技术栈
重点了解微服务技术栈：
学成在线服务端基于Spring Boot构建，采用Spring Cloud微服务框架。
持久层：MySQL、MongoDB、Redis、ElasticSearch
数据访问层：使用Spring Data JPA 、Mybatis、Spring Data Mongodb等
业务层：Spring IOC、Aop事务控制、Spring Task任务调度、Feign、Ribbon、Spring AMQP、Spring Data Redis等。
控制层：Spring MVC、FastJSON、RestTemplate、Spring Security Oauth2+JWT等
微服务治理：Eureka、Zuul、Hystrix、Spring Cloud Config等
2.3 开发步骤
项目是基于前后端分离的架构进行开发，前后端分离架构总体上包括前端和服务端，通常是多人协作并行开发，开
发步骤如下：
1、需求分析
梳理用户的需求，分析业务流程
2、接口定义
根据需求分析定义接口
3、服务端和前端并行开发
依据接口进行服务端接口开发。
前端开发用户操作界面，并请求服务端接口完成业务处理。
4、前后端集成测试
最终前端调用服务端接口完成业务。
3.1 Swagger常用注解
@Api：修饰整个类，描述Controller的作用
@ApiOperation：描述一个类的一个方法，或者说一个接口
@ApiParam：单个参数描述
@ApiModel：用对象来接收参数
@ApiModelProperty：用对象接收参数时，描述对象的一个字段
@ApiResponse：HTTP响应其中1个描述
@ApiResponses：HTTP响应整体描述
@ApiIgnore：使用该注解忽略这个API
@ApiError ：发生错误返回的信息
@ApiImplicitParam：一个请求参数
@ApiImplicitParams：多个请求参数
@ApiImplicitParam属性：