بدون توضیح

suxiaoyang e652ae6a63 Cat 6 سال پیش
src 4bfbc34349 代码架构更新,POM文件更新 6 سال پیش
.gitignore e25eb2ab3c gitignore追加 6 سال پیش
pom.xml e652ae6a63 Cat 6 سال پیش
readme.md 239031f719 first commit 6 سال پیش

readme.md

备注:<> 指变量

ElasticSearch

a.服务说明:
    1.该服务是对ElasticSearch搜索引擎的集成,提供了一些相对常用的操作接口
b.配置说明:
    2.详见application.yml文件,其中如果有多个cluster-nodes请以逗号(,)分隔
c.调用说明:
    1.初始化索引(相当于建立数据库表)
        1).索引文档之前请勿必请求mapping接口进行字段映射,不然可能发生检索结果不准确的情况
        2).参数
            index
                - 参数格式:"<index>"
                - 参数说明:索引名称
            type 
                - 参数格式:"<type>"
                - 参数说明:索引类型
            source
                - 参数格式:{"<field>":{"type":"<string|byte|short|integer|long|float|double|boolean|date>","store":"<yes|or>"},"<...>":{<...>}}
                - 参数说明:
                    field值为字段名称,字段可选属性还有index、analyzer、search_analyzer、format
                    当字段不分词时形如:{"name":{"type":"string","index":"not_analyzed"}}
                    当字段要分词时形如:{"name":{"type":"string","analyzer":"ik","search_analyzer":"ik"}}
                    当字段为date类型时可指定时间格式:["createDate":{"type":"date","format":"yyyy-MM-dd HH:mm:ss"}}
                    当字段特别长的时候可选择store为yes否则默认为no
    2.索引文档(相当于插入数据)
        1).请求index接口
        2).参数
            index
                - 同上
            type
                - 同上
            source
                - 参数格式:{"<field>":"<value>","<field>":<value>,"field":"<yyyy-MM-dd HH:mm:ss>"}
                - 参数说明:filed指字段名称,value指字段值,其中时间格式为yyyy-MM-dd HH:mm:ss
    3.删除索引(相当于删除数据)
        1).请求delete接口
        2).参数
            index
                - 同上
            type
                - 同上
            id
                - 参数格式:"id1,id2,..."
                - 参数说明:多个数值以逗号(,)分隔
    4.更新索引(相当于更新数据)
        1).请求update接口
        2).参数
            index
                - 同上
            type
                - 同上
            id
                - 参数格式:"<id>"
                - 参数说明:原文档ID
            source
                - 参数格式:同index接口
                - 参数说明:数据中请勿包含原文档ID(_id)
    5.获取单条数据
        1).请求findById接口
        2).参数
            index
                - 同上
            type
                - 同上
            id
                - 同上
    6.简单数据检索(findByFiled)
        1).请求findByField接口
        2).参数
            index
                - 同上
            type
                - 同上
            field
                - 参数格式:"<field>"
                - 参数说明:字段名称
            value
                - 参数格式:初始化索引时,该字段对应的类型
                - 参数说明:字段值
    7.组合数据检索(page)
        1).请求page接口,支持模糊查询,完全匹配,范围查询
        2).参数
            index
                - 同上
            type
                - 同上
            filter
                - 参数格式:field1=xxx;field=xxx
            page
                - 参数说明:页码
            size 
                - 参数说明:分页大小

FastDFS

a.服务说明:
    1.此服务在FastDFS的文件服务中加入了建立在ElasticSearch基础上的文件检索功能,以解决FastDFS在文件管理中的缺陷
    --- 索引信息 Start ---
    {"sn":{"type":"string","index":"not_analyzed"},"name":{"type":"string","analyzer":"ik","search_analyzer":"ik"},"path":{"type":"string","index":"not_analyzed"},"objectId":{"type":"string","index":"not_analyzed"},"size":{"type":"integer"},"type":{"type":"string","index":"not_analyzed"},"createDate":{"type":"date","format":"yyyy-MM-dd HH:mm:ss"},"creator":{"type":"string","index":"not_analyzed"},"modifyDate":{"type":"date","format":"yyyy-MM-dd HH:mm:ss"},"modifier":{"type":"string","index":"not_analyzed"}}
    {
        "sn": {
            "type": "string",
            "index": "not_analyzed"
        },
        "name": {
            "type": "string",
            "analyzer": "ik",
            "search_analyzer": "ik"
        },
        "path": {
            "type": "string",
            "index": "not_analyzed"
        },
        "objectId": {
            "type": "string",
            "index": "not_analyzed"
        },
        "size": {
            "type": "integer"
        },
        "type": {
            "type": "string",
            "index": "not_analyzed"
        },
        "createDate": {
            "type": "date",
            "format": "yyyy-MM-dd HH:mm:ss"
        },
        "creator": {
            "type": "string",
            "index": "not_analyzed"
        },
        "modifyDate": {
            "type": "date",
            "format": "yyyy-MM-dd HH:mm:ss"
        },
        "modifier": {
            "type": "string",
            "index": "not_analyzed"
        }
    }
    --- 索引信息 End ---
b.配置说明:
    1.详见application.yml文件,其中如果有多个tracker-server,请用逗号(,)分隔
    2.新增部署服务的时候请确保基础信息管理的系统字典里面有名称为"FastDFS外链地址"的字典项,并添加值为可用的http外链地址的字典值,可添加多个
c.调用说明:
    1.文件上传
        1).upload
        2).参数
            file
                - 参数说明:文件
            creator
                - 参数说明:当前登陆用户ID
            objectId
                - 参数说明:如用户ID、机构ID
    2.文件上传(兼容旧接口)
        1).oldUpload
        2).参数
            jsonData
                - 参数格式:{"fileStr":"文件流Base64转码后生成的字符串","fileName":"中华人民共和国.jpg","objectId":"2698","creator":"0dae0003598196f1319e6d68c546d40e"}
                - 参数说明:objectId - 如用户ID、机构ID
                           creator - 当前登陆用户ID
    3.文件删除
        1).deleteBy*
        2).参数
            id:唯一索引
            path:存储路径(groupName:remoteName)
            objectId:如用户ID,机构ID
    4.文件修改
        1).modify
        2).参数
            file
                - 参数说明:文件
            path
                - 参数说明:旧文件路径
            _id
                - 参数说明:旧文件唯一索引ID
            modifier
                - 参数说明: 修改者
    5.文件修改(兼容旧接口)
        1).oldModify
        2).参数
            jsonData
                - 参数格式:{"fileStr":"文件流Base64转码后生成的字符串","fileName":"中华人民共和国.jpg","path":"group1:M00/1F/02/rBFuWFomFJuAfO9aAABbPC2Anrc140.jpg","_id":"AWAkvqu0uMfQEAkULzP8","modifier":"0dae0003598196f1319e6d68c546d40f"}
                - 参数说明:fileStr - 新文件流
                           fileName - 新文件名
                           path - 原先文件的路径
                           _id - 原先文件的唯一索引
                           modifier - 当前操作的用户ID
    6.获取文件信息
        1).fileInfo
        2).参数
            path:存储路径(groupName:remoteName)
    7.文件下载(该接口返回文件流Base64转码后生成的字符串)
        1).downloadBy*
        2).参数
            id:唯一索引
            path:存储路径(groupName:remoteName)
            objectId:如用户ID,机构ID
    8.下载文件至本地(downloadToLocal)本接口为测试用,忽略
    9.获取文件下载路径
        1).getFilePath
        2).参数
            objectId:如用户ID,机构ID
    10.获取分页
        1).page
        2).参数
            filter
                - 参数格式:[{"andOr":"and|or","condition":">|=|<|>=|<=|?"},"field":"<filed>","value":"<value>"},<{...}>]
                - 参数说明:andOr跟数据库的中的AND和OR相似;condition指条件匹配程度,?相当于数据库中的like;filed指检索的字段;value为检索的值
            page 
                - 页码
            size
                - 分页大小
    11.获取服务器状态信息
        1).status
    12.获取外链地址(该接口返回的地址指的是可在浏览器直接访问的文件下载的根路径)
        1).getPublicUrl
    13.设置外链地址
        1).setPublicUrl
        2).参数
            jsonData
                - 参数格式:{"dictId":107,"code":"URL_1","value":"http://172.19.103.52:801","sort":1,"phoneticCode":"HTTP://172.19.103.52:80","catalog":"HTTP"}
                - 参数说明:字典项json串