车联网1.x+2.x模块化使用文档 V1.2

公共文档

变更历史

1 概述

1.1 背景及现状

随着公司的车联网系统不断迭代开发，当前公司车联网的框架已不能快速应对客户提出的各种需求开发。当前主要存在如下几个问题：

• 系统框架陈旧，开发效率低下
• 经过长时间的无规范开发，源码已经十分杂乱，代码执行效率低，并且开发效率严重受到影响
• 系统缺少统一认证中心，用户使用和管理比较麻烦
• 缺少模块化管理

1.2 模块化框架

该模块化设计是在基于车联网系统进行改造的，并没有采用CAS之类的现成单点登录方案，而是根据项目的实际情况，对原先项目进行改造，使其支持单点登录和模块化。为了支持上述特性，分别进行了如下几项工作：

• 1、对车联网的项目代码进行扩展，增加了模块化特性和单点验证支撑
• 2、采用Spring Boot搭建一个基础业务模块，集成了单点登录。采用了Shiro作为安全权限框架，Mybatis作为ORM。
• 3、各个模块子系统之间，通过共享Session会话共享实现统一用户认证。
• 4、静态资源文件，通过搭建一个公共的静态资源访问(js/css)，达到样式统一和资源共用目的。
• 5、部署时通过nginx分发，实现会话共享

2 基础业务模块

2.1 模块配置

2.1.1 用户中心配置

用户中心配置在application-xxx.yml文件中，配置项参见:

ucenter:
  #serverPort: 8080   #用户中心对外开放端口，这里即车联网系统对外开放端口，因为原车网系统兼用户认证中心
  #clientPort: 88     #基础模块对外开放端口
  context-path: /module-demo
  cdn: http://127.0.0.1:8080 # 公共资源服务器，一般设为车联网外网地址即可。

2.1.2 资源菜单配置

资源菜单是通过xml文件进行配置，避免手工在系统中管理来的混乱。配置文件为 module-resource.xml,详细配置格式参见：

    <!-- name即为模块名，必须保证唯一性 -->
<resource version="1.0" >
    <!-- 这里的parent-name指的是模块的上级菜单， icon即图标，order为顺序 -->
    <menu name="模块测试" parent-name="/" icon="" order="10">
        <menu name="列表页面"  url="/demo/list" icon="" order="1">
            <button name="新增" url="/demo/add">
            </button>
        </menu>
        <menu name="图表页面" url="/demo/list1" icon="" order="2">
        </menu>
    </menu>
</resource>

2.1.3 车联网配置

车联网系统需要将tomcat里的conf/context.xml配置更新一下，即配置sessionCookieName：

<?xml version='1.0' encoding='utf-8'?>
<Context sessionCookieName="UCENTER_SESSION_ID">
.........
</Context>

2.2 模块常用操作

2.2.1 模块运行

模块采用的是Spring boot搭建，启动方式比较简单，直接右击运行Application即可。运行效果图如下：

2.2.2 模块安装卸载

基础业务模块提供了简易的模块安装和卸载的接口，通过浏览器调用，可能实现模块的安装卸载。（模块信息在module-resource.xml配置）

2.2.2.1 查看模块信息

调用http://xxxx:xx/module/view即可以查看菜单资源的定义

2.2.2.2 安装

调用http://xxxx:xx/module/install即可以对模块进行安装，每一次调用，都会先把模块的菜单资源清理再重新注册。

注意，安装只是将模块信息增加到车联网的模块管理中，用户如果想看到对应模块，需要给角色分配权限。

2.2.2.3 卸载

调用http://xxxx:xx/module/uninstall即可以对模块进行卸载，操作会将车网系统中的有关当前模块的菜单都清理完毕。

附录

A 常用实体介绍

A.1 用户个人信息

com.bitnei.commons.bean.WebUser

public class WebUser implements Serializable{
    //用户ID
    private String id;
    //用户名
    private String username;
    //密码
    private String password;
    //姓名
    private String realName;
    //用户状态，1：可用
    private Integer state;
    //角色列表
    private Set<String> roles = new HashSet<>();
    //权限列表
    private Set<String> authorities = new HashSet<>();
    //附加信息
    private Map<String,Object> extData = new HashMap<>();
}

B 常用工具类

B.1 Servlet工具类

com.bitnei.cloud.common.util.ServletUtil

参见模块化JavaDoc

C 导出文件

C.1 流程描述

在这里，以导出系统日志为示例：

1、编写mysql语句： 正常情况下，我们可以直接使用数据列表的sql语句，如下

 <!-- 分页查询 -->
    <select id="pagerModel" resultMap="tailResults" parameterType="java.util.HashMap">
        select
        <include refid="moreColumns"/>
        from
        base_log log
        where
        1=1
        <if test="username != null">
        and log.username like "%"#{username}"%"
        </if>
        <if test="moudle != null">
        and log.moudle like "%"#{moudle}"%"
        </if>
        <if test="action != null">
        and log.action like "%"#{action}"%"
        </if>
        ORDER BY log.TIME DESC
    </select>

2、业务层采集数据： 如果模块代码是通过代码生成工具生成的，正常业务层代码是不需要改动的

    @Override
    public void export() {
        List list = findBySqlId("pagerModel",ServletUtil.getQueryParams());
        String srcBase = RequestContext.class.getResource("/templates/").getFile();
        String srcFile = srcBase +"module/base/log/export.xls";
        ExcelData ed = new ExcelData();
        ed.setTitle("日志管理");
        ed.setExportTime(DateUtil.getNow());
        ed.setData(list);
        String outName = String.format("%s-导出-%s.xls", "日志管理", DateUtil.getShortDate());
        EasyExcel.renderResponse(srcFile,outName,ed);
    }

3、配置excel模板： 框架的excel模板为export.xls，excel文件中共有两个sheet,一个为列定义，一个参数配置。详细的excel配置，将在下面章节进行描述。