背景

在日常生活中，内容管理系统占到所有系统的80%以上，比如个人博客，腾讯新闻，今日头条，搜狐新

闻等。

这些都是我们日常生活中经常使用到的系统，它的核心就是可以概括为内容（资讯），一篇文章就是一

个资讯，大家越来越喜欢将生活中的所见所闻简述出来。

如图

通用的看点资讯管理系统，采用前后台分离开发的技术，将系统分为前台页面展示以及后台资讯管理系

统。对于后台系统是基本上是通用的，而前台可根据不同客户的需求去修改定制。

简介

看点资讯系统最核心的数据是内容，例如文章、新闻等，所以后台主要功能是实现这些内容的管理，例

如栏目管理、评论管理、用户管理以及角色管理等，对于前台可以灵活得展示后台的数据。

技术要求

后台采用的技术：

springboot

spring

springmvc

springdata-jpa

数据库：

mysql

文档管理：

swagger

架构选取：

三层架构

功能

注意，Controller中的返回值类型，统一采用自定义的Result类型

Result.java

package com.briup.cms.util;

import java.io.Serializable;

/**
 * 统一Controller中RESTFul风格接口返回的结果
 */
public class Result implements Serializable {

	private static final long serialVersionUID = 1L;
	
	private Integer code;
	private String msg;
	private Object data;
	
	private Result() {}
	
	private Result(Integer code, String msg) {
		this.code = code;
		this.msg = msg;
	}
	
	private void setResultCode(ResultCode code) {
		this.code = code.code();
		this.msg = code.message();
	}
	
	/**
	 * 操作失败，自定义code和msg
	 */
	public static Result failure(Integer code, String msg) {
		Result result = new Result(code,msg);
		return result;
	}
	
	/**
	 * 操作成功，没有返回的数据
	 */
	public static Result success() {
		Result result = new Result();
		result.setResultCode(ResultCode.SUCCESS);
		return result;
	}
	
	/**
	 * 操作成功，有返回的数据
	 */
	public static Result success(Object data) {
		Result result = new Result();
		result.setResultCode(ResultCode.SUCCESS);
		result.setData(data);
		return result;
	}
	
	/**
	 * 操作失败，没有返回的数据
	 */
	public static Result failure(ResultCode resultCode) {
		Result result = new Result();
		result.setResultCode(resultCode);
		return result;
	}
	
	/**
	 * 操作失败，有返回的数据
	 */
	public static Result failure(ResultCode resultCode, Object data) {
		Result result = new Result();
		result.setResultCode(resultCode);
		result.setData(data);
		return result;
	}
	
	public Integer getCode() {
		return code;
	}

	public void setCode(Integer code) {
		this.code = code;
	}

	public String getMsg() {
		return msg;
	}

	public void setMsg(String msg) {
		this.msg = msg;
	}

	public Object getData() {
		return data;
	}

	public void setData(Object data) {
		this.data = data;
	}
	
}

ResultCode.java

package com.briup.cms.util;

/**
 * 统一并自定义返回状态码，如有需求可以另外增加
 */
public enum ResultCode {
	
	/* 成功状态码 */
	SUCCESS(1, "操作成功"),
	
	/* 参数错误：10001-19999 */
	PARAM_IS_INVALID(10001, "参数无效"),
	PARAM_IS_BLANK(10002, "参数为空"),
	PARAM_TYPE_BIND_ERROR(10003, "参数类型错误"),
	PARAM_NOT_COMPLETE(10004, "参数缺失"),
	
	
	/* 用户错误：20001-29999*/
	USER_NOT_LOGIN(20001, "用户未登录"),
	USER_LOGIN_ERROR(20002, "账号不存在或密码错误"),
	USER_ACCOUNT_FORBIDDEN(20003, "账号已被禁用"),
	USER_NOT_EXIST(20004, "用户不存在"),
	USER_HAS_EXISTED(20005, "用户已存在"),
	USER_NAME_ISNULL(20006, "用户名为空"),
	USER_PASS_ISNULL(20007, "密码为空"),
	USER_PASS_ERROR(20007, "密码为空或密码错误"),
	
	/* 业务错误：30001-39999 */
	SPECIFIED_QUESTIONED_USER_NOT_EXIST(30001, "业务逻辑出现问题"),
	
	/* 系统错误：40001-49999 */
	SYSTEM_INNER_ERROR(40001, "系统内部错误，请稍后重试"),
	
	/* 数据错误：50001-599999 */
	DATA_NONE(50001, "数据未找到"),
	DATA_WRONG(50002, "数据错误"),
	DATA_EXISTED(50003, "数据已存在"),
	CONTENT_IS_NULL(50004,"内容为空"),
	TITLE_IS_NULL(5000,"标题为空"),
	/* 接口错误：60001-69999 */
	INTERFACE_INNER_INVOKE_ERROR(60001, "内部系统接口调用异常"),
	INTERFACE_OUTTER_INVOKE_ERROR(60002, "外部系统接口调用异常"),
	INTERFACE_FORBID_VISIT(60003, "该接口禁止访问"),
	INTERFACE_ADDRESS_INVALID(60004, "接口地址无效"),
	INTERFACE_REQUEST_TIMEOUT(60005, "接口请求超时"),
	
	/* 权限错误：70001-79999 */
	PERMISSION_NO_ACCESS(70001, "无访问权限");
	
	
	private Integer code;

	private String message;

	ResultCode(Integer code, String message) {
		this.code = code;
		this.message = message;
	}

	public Integer code() {
		return this.code;
	}

	public String message() {
		return this.message;
	}
}

用户模块

对应的实体类为 User

1、新增用户

参数1：User

2、编辑用户

参数1：User

3、查询用户（分页）

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

4、删除用户（批量，注销用户）

参:1：List<Long> ids

5、禁用或解封用户信息（更新用户状态）

参数1：Long id

参数2：String status

6、根据用户名获取用户信息

参数1：String username

7、登录

参数1：String username

参数2：String password

角色模块

对应的实体类为 Role

1、新增角色

参数1：Role r

2、编辑角色参数1：Role r

3、查询角色（分页）

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

4、批量删除角色

参数1：List<Long> ids

资讯模块

资讯在这里主要指的的是文章，对应的实体类为 Article

1、新增资讯

参数1：Article article

2、编辑资讯

参数1：Article article

3、查询资讯（分页）

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

4、批量删除资讯

参数1：List<Long> ids

5、审核资讯

参数1：Long id

参数2：String status

6、根据类别ID查询，分页获取资讯信息，并且按照阅读量降序排

参数1：Long categoryId

参数2：

Integer pageNum

参数3：

Integer pageSize7、根据用户分页获取资讯信息

参数1：Long userId

参数2：

Integer pageNum

参数3：

Integer pageSize

类别模块

类别也就是栏目： Category

1、新增类别

参数1：Category category

2、编辑类别

参数1：Category category

3、查询类别（分页）

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

4、批量删除类别

参数1：List<Long> ids

5、更新类别序号

参数1：Long id

参数2：Long no

6、按照序号升序分页获取类别信息

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

评论模块

对应的实体类为 Comment1、新增评论

参数1：Comment comment

2、编辑评论

参数1：Comment comment

3、批量删除评论

参数1：List<Long> ids

4、查询评论（分页）

参数1：

Integer num(页数)

参数2：

Integer size（每页显示多少条数据）

5、分页获取指定文章下所有的评论

参数1：Long articleId

参数2：

Integer num

参数3：

Integer size

字典

1、用户表，cms_user

2、角色表，cms_role

3、文章类别表，cms_category

4、文章表，cms_article

5、评论表，cms_comment

注意，因为项目中使用了JPA，可以在实体类中配置完关系映射后，让JPA根据配置自动创建表

这是前期的数据库和一些基本配置