ProtoBuf的实例

最新推荐文章于 2021-07-03 16:52:08 发布
原创 最新推荐文章于 2021-07-03 16:52:08 发布 · 736 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#protobuf

本文介绍了一种基于Proto文件的登录接口实现方案。通过详细解析LoginMsg.proto文件内容及其生成的Java类，展示了如何进行登录请求及响应处理，并对关键业务逻辑进行了封装。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

本文将以本人的登录采用proto文件传输，来介绍总结Proto文件的使用步骤
（一）编写Msg.proto文件

以登录的Proto文件例如：LoginMsg.proto文件

message Login{

    message EprUserAbilityVo{
       message EprInfoVo{
         required int32 id = 1;
         required int32 parentEprId = 2;
         required string company = 3;
         required string contact = 4;
         required string registerDate = 5;
       }
       message AbilityAuthVo{
         required bool pbxFlag = 1;
         required bool pstnFlag = 2;

       }

       message PbxUserExtensionVo{
         optional int32 eprId = 1;
         optional string extensionNum = 2;
         optional string extensionPwd =3;
         optional string domain = 4;
         optional string domainname = 5;
         optional string userId = 6;
         optional string extensionId = 7;
         optional string transportProtocol=8;
         optional string port=9;

       }


      required EprInfoVo  eprInfoVo = 1;
      required AbilityAuthVo abilityAuthVo = 2;
      optional PbxUserExtensionVo pbxUserExtensionVo =3;

   }


   message ApiUserInfo{
         required int32 id= 1;
         required string userId = 2;
         required string userName = 3;
         optional int32 sex= 4;
         required string password = 5;
         required string passwordMD5 = 6;
         optional string headImage = 7;
         optional string headImgByte = 8;
         optional string imgByte = 9;
         required string sessionId = 10;

    }


message DataContent{

     repeated   EprUserAbilityVo eprUserAbilityVo = 1;  
     required ApiUserInfo apiUserInfo = 2;
}

optional DataContent data = 1;

required string message = 2;
required string code = 3;
required string status =4;
optional string def1 = 5;
optional string def2 = 6;

}

（二）将Proto文件生成Java 类LoginMsg.java

通过cmd命令：protoc.exe –java_out=E:\java LoginMsg.proto

此处不再列代码

（三）Java类的使用封装

（1）登录Controller

    /**
     * 手机端登录接口
     * 
     *（1）   requestTime : 请求接口的时间，时间串格式yyyyMMddHHmmss
     *（2）   apiKey: 接口请求秘钥：
                             安卓：CAN80101JYTX  
            IOS: CIP80101JYTX
    * （3）   osVersion: 当前移动手机的系统版本号 Andriod 7.0, IOS 10.2.3
    * （4）   deviceName: 设备名称： MEIZU X6 ; 5，5s，6，6p
    * （5）   deviceMeid:  设备唯一标识：86106903106332
    * （6）   appVersion: 云总机APP的版本（尤其用在安卓时候，定时更新）
     */
    @ResponseBody
    @RequestMapping(value = "/login", method = RequestMethod.POST)
    public void login(@RequestBody Map<String, Object>  paramMap,HttpServletResponse response) {
          LoginMsg.Login.Builder loginBuilder = LoginMsg.Login.newBuilder();
        try {
            Map<String, Object> ver_map = apiComService.checkComParams(paramMap);// 验证map
            loginService.apiLogin(ver_map,response);
        }catch (InterfaceException e) {
            e.printStackTrace();
            ResponseData responseData =  new ResponseData(ResponseData.ERROR,e.getMessage(),Constants.getParaValue(e.getMessage()));
            loginService.ResponseDataToLogin(responseData, loginBuilder, response);
        }  catch (Exception e) {
            e.printStackTrace();
            ResponseData responseData =  new ResponseData(ResponseData.ERROR,"0002",Constants.getParaValue("0002"));
            loginService.ResponseDataToLogin(responseData, loginBuilder, response);
        }

    }

（2）登录service实现方法


@Service
public class LoginServiceImpl implements ILoginService {


    @Override
    public void apiLogin(Map<String, Object> ver_map,HttpServletResponse response) {
        // TODO Auto-generated method stub
           LoginMsg.Login.Builder loginBuilder = LoginMsg.Login.newBuilder();
       try {
           Object   requestData =   (Object) ver_map.get("requestData");

            if (requestData==null) {
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0709",Constants.getParaValue("0709"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            log.debug("请求参数"+ JsonLib.toJson(ver_map));
            System.out.println("请求参数"+ JsonLib.toJson(ver_map));
            JSONObject requestObj = JSONObject.fromObject(requestData);
            String userId = requestObj.optString("userAccount");
            String passwordMd5 = requestObj.optString("password");
            if(StringUtil.isNull(userId)){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0710",Constants.getParaValue("0710"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            if(!Checker.isMobilePhone(userId)){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0711",Constants.getParaValue("0711"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            if(StringUtil.isNull(passwordMd5)){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0712",Constants.getParaValue("0712"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            // 判断用户和密码是否存在用户

            UserInfoForm user = userInfoDao.getUserInfoByUserId(userId);
            if(user == null ){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0713",Constants.getParaValue("0713"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            if (!user.getPasswordMD5().equalsIgnoreCase(passwordMd5)){

                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0714",Constants.getParaValue("0714"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            ApiUserInfo apiUserInfo = new ApiUserInfo(user);
            String sessionId = apiSessionUtils.login(apiUserInfo);
            if(StringUtil.isNull(sessionId)){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0715",Constants.getParaValue("0715"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }
            apiUserInfo.setSessionId(sessionId);
            // 判断企业是否开通总机，用户是否有总机权限

           // 判断当前用户是否有多个组织机构，如果不存在，就不让登录

            UserOrgEntity userOrgEntity =new UserOrgEntity();
            userOrgEntity.setUserId(userId);
            List<UserInfoEntity> userlist =  userOrgDao.getUserEprInfoList(userOrgEntity);
            if(!(userlist != null && userlist.size()>0)){
                ResponseData responseData =  new ResponseData(ResponseData.FAULT,"0783",Constants.getParaValue("0783"));
                ResponseDataToLogin(responseData, loginBuilder, response);
            }

            Map<String, Object> params = new HashMap<String, Object>();
            params.put("userId", userId);
            params.put("passwordMD5", passwordMd5);
            List<EprInfoForm> eprInfoList = userInfoDao.selectEprInfoByMap(params);
            List<EprUserAbilityVo> eprUserAbilityList = new ArrayList<EprUserAbilityVo>();

            // 按照定义的数据结构，创建一个Login

            LoginMsg.Login.DataContent.Builder dataContent =    LoginMsg.Login.DataContent.newBuilder();
            LoginMsg.Login.ApiUserInfo.Builder apiUserInfoPro = LoginMsg.Login.ApiUserInfo.newBuilder();

            // protobuffer 的apiUserInfo 赋值
            apiUserInfoPro.setId(apiUserInfo.getId());
            apiUserInfoPro.setUserId(apiUserInfo.getUserId());
            apiUserInfoPro.setUserName(apiUserInfo.getUserName());
            apiUserInfoPro.setSex(apiUserInfo.getSex());
            apiUserInfoPro.setPassword(apiUserInfo.getPassword());
            apiUserInfoPro.setPasswordMD5(apiUserInfo.getPasswordMD5());
            if(!StringUtil.isNull(apiUserInfo.getHeadImage())){
                apiUserInfoPro.setHeadImage(apiUserInfo.getHeadImage());
            }
            if(!StringUtil.isNull(apiUserInfo.getHeadImgByte())){
                apiUserInfoPro.setHeadImgByte(apiUserInfo.getHeadImgByte());
            }
            if(apiUserInfo.getImgByte() != null){
                apiUserInfoPro.setImgByte(apiUserInfo.getImgByte().toString());
            }


            apiUserInfoPro.setSessionId(apiUserInfo.getSessionId());
            dataContent.setApiUserInfo(apiUserInfoPro);

            if(eprInfoList!=null && eprInfoList.size()>0){
                for(EprInfoForm eprInfo : eprInfoList ){
                       // protobuffer 的单个对象初始化
                    LoginMsg.Login.EprUserAbilityVo.Builder eprUserAbilityPro = LoginMsg.Login.EprUserAbilityVo.newBuilder();
                    LoginMsg.Login.EprUserAbilityVo.EprInfoVo.Builder eprInfoPro = LoginMsg.Login.EprUserAbilityVo.EprInfoVo.newBuilder();
                    LoginMsg.Login.EprUserAbilityVo.AbilityAuthVo.Builder abilityAuthPro = LoginMsg.Login.EprUserAbilityVo.AbilityAuthVo.newBuilder();
                    LoginMsg.Login.EprUserAbilityVo.PbxUserExtensionVo.Builder pbxUserExtensionPro = LoginMsg.Login.EprUserAbilityVo.PbxUserExtensionVo.newBuilder();

                     // protobuffer 的eprInfoPro 赋值
                    eprInfoPro.setId(eprInfo.getId());
                    eprInfoPro.setParentEprId(eprInfo.getParentEprId());
                    eprInfoPro.setCompany(eprInfo.getCompany());
                    eprInfoPro.setContact(eprInfo.getContact());
                    eprInfoPro.setRegisterDate(DateUtil.dateToStr(eprInfo.getRegisterDate(), DateUtil.DATE_TIME_LINE));

                    EprUserAbilityVo eprUserAbility = new EprUserAbilityVo();
                    EprInfoVo eprInfoVo = new EprInfoVo(eprInfo);
                    PbxUserExtensionVo pbxUserExtensionVo = null;
                    AbilityAuthVo abilityAuthVo = new AbilityAuthVo();
                    Map<String, Object> pbxExtensionUserMap =  new HashMap<String, Object>();
                    pbxExtensionUserMap.put("userId", userId);
                    pbxExtensionUserMap.put("eprId", eprInfo.getId());                  
                    PbxExtensionEntity  pbxExtension =pbxExtensionDao.selectOnePbxExtensionByMap(pbxExtensionUserMap);
                    if(pbxExtension!= null){
                        PbxEntity pbx = pbxDao.selectOneByEprId(eprInfo.getId());
                        if(pbx != null){
                            pbxUserExtensionVo = new PbxUserExtensionVo(pbx, pbxExtension);
                            //
                             Map<String, Object> map = new HashMap<String, Object>();
                             map.put("code", "d_transport_protocol");
                             DictForm dictForm = dictService.queryOneByMap(map);
                             if(dictForm != null ){
                                 pbxUserExtensionVo.setTransportProtocol(dictForm.getRemark());
                             }

                             Map<String, Object> mapPort = new HashMap<String, Object>();
                             mapPort.put("code", "d_transport_port");
                             DictForm dictPortForm = dictService.queryOneByMap(mapPort);

                             if(dictPortForm!=null){
                                 pbxUserExtensionVo.setPort(dictPortForm.getRemark());
                             }
                        //  pbxUserExtensionVo

                            abilityAuthVo.setPbxFlag(true);
                            // protoco buffer pbxUserExtensionPro 初始化
                            pbxUserExtensionPro.setEprId(pbxUserExtensionVo.getEprId());
                            pbxUserExtensionPro.setExtensionPwd(pbxUserExtensionVo.getExtensionPwd());
                            pbxUserExtensionPro.setDomain(pbxUserExtensionVo.getDomain());
                            pbxUserExtensionPro.setExtensionId(pbxUserExtensionVo.getExtensionId());
                            pbxUserExtensionPro.setExtensionNum(pbxUserExtensionVo.getExtensionNum());
                            pbxUserExtensionPro.setDomainname(pbxUserExtensionVo.getDomainname());
                            pbxUserExtensionPro.setUserId(pbxUserExtensionVo.getUserId());
                            pbxUserExtensionPro.setTransportProtocol(pbxUserExtensionVo.getTransportProtocol());
                            pbxUserExtensionPro.setPort(pbxUserExtensionVo.getPort());
                            // protoco buffer abilityAuthPro 初始化

                        }
                    }

                    abilityAuthPro.setPbxFlag(abilityAuthVo.getPbxFlag());
                    abilityAuthPro.setPstnFlag(abilityAuthVo.getPstnFlag());

                    eprUserAbility.setEprInfoVo(eprInfoVo);
                    eprUserAbility.setAbilityAuthVo(abilityAuthVo);
                    eprUserAbility.setPbxUserExtensionVo(pbxUserExtensionVo);
                    eprUserAbility.setApiUserInfo(apiUserInfo);
                    eprUserAbilityList.add(eprUserAbility);
                    //  protoco buffer eprUserAbility 包装各个实体
                    eprUserAbilityPro.setEprInfoVo(eprInfoPro);
                    eprUserAbilityPro.setAbilityAuthVo(abilityAuthPro);
                    eprUserAbilityPro.setPbxUserExtensionVo(pbxUserExtensionPro);
                    // 放到集合中
                    dataContent.addEprUserAbilityVo(eprUserAbilityPro);

                }
            }
            Map<String, Object>  resultMap = new HashMap<String, Object>();
            resultMap.put("eprUserAbilityList", eprUserAbilityList);
            resultMap.put("apiUserInfo", apiUserInfo);

            // protobuffer 封装整体对象
            loginBuilder.setData(dataContent);
//          loginBuilder.setMessage( Constants.getParaValue("0716"));
//          loginBuilder.setCode("0716");
//          loginBuilder.setStatus(ResponseData.OK);
////            loginBuilder.setDef1("123");
////            loginBuilder.setDef2("456");
//          
//          LoginMsg.Login xxz = loginBuilder.build();
//          // 将数据写到输出流，如网络输出流，这里用到ByteArrayOutSream 来代替
//          ByteArrayOutputStream output = new ByteArrayOutputStream();
//          xxz.writeTo(output);
//          
//          byte[] content = output.toByteArray();
//          
//          response.setContentType("application/x-protobuf");  
//          response.setContentLength(content.length);  
//          response.setCharacterEncoding("utf-8");  
//          OutputStream out = response.getOutputStream();  
//          out.write(content);  
//          out.flush();  
//          out.close(); 

            ResponseData responseData =  new ResponseData(resultMap, ResponseData.OK, "0716", Constants.getParaValue("0716"));
            ResponseDataToLogin(responseData, loginBuilder, response);
        }catch (InterfaceException e) {
            e.printStackTrace();
            ResponseData responseData =  new ResponseData(ResponseData.ERROR,e.getMessage(),Constants.getParaValue(e.getMessage()));
            ResponseDataToLogin(responseData, loginBuilder, response);
        }  catch (Exception e) {
            e.printStackTrace();
            ResponseData responseData =  new ResponseData(ResponseData.ERROR,"0002",Constants.getParaValue("0002"));
            ResponseDataToLogin(responseData, loginBuilder, response);
        }
    }



    @Override
    public void ResponseDataToLogin(ResponseData responseData,Builder loginBuilder,HttpServletResponse response) {
        // TODO Auto-generated method stub
        log.info("JsonLib"+JsonLib.toJson(responseData));
        System.out.println("JsonLib"+JsonLib.toJson(responseData));
        try {
            loginBuilder.setMessage(responseData.getMessage());
            loginBuilder.setCode(responseData.getCode());
            loginBuilder.setStatus(responseData.getStatus());
    //      loginBuilder.setDef1(responseData.getDef1().toString());
    //      loginBuilder.setDef2(responseData.getDef2().toString());
            LoginMsg.Login xxz = loginBuilder.build();
            // 将数据写到输出流，如网络输出流，这里用到ByteArrayOutSream 来代替
            ByteArrayOutputStream output = new ByteArrayOutputStream();
            xxz.writeTo(output);
            byte[] content = output.toByteArray();
            response.setContentType("application/x-protobuf");  
            response.setContentLength(content.length);  
            response.setCharacterEncoding("utf-8");  
            OutputStream out = response.getOutputStream();  
            out.write(content);  
            out.flush();  
            out.close(); 

        }catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
    }


}
XingAmanda
关注
cmake 操作protobuf实例
machh的专栏
07-27 473
最后给可执行文件链接protobuf库。查找并链接protobuf。
Protobuf 实例（java），java并发编程基础
m0_64867896的博客
12-22 268
protobuf-java 3.15.8 protobuf文件名为 d_cook_records.proto，内容如下： syntax = “proto3”; import “google/protobuf/any.proto”; // option java_package=“com.galanz.iot.content.restapi.model.proto”; option java_outer_classname=“DCookRecordsProto”; // DCookRecords
protobuf例子
07-02
最简单的用socket发送protobuf对象的例子，
Protobuf实例
BorisCao的博客
05-25 464
Protobuf实例Protobuf简介Protobuf实例定义proto协议类信息属性使用定义Builder设置属性值设置属性对象返回对象Protobuf的github地址 Protobuf简介 protobuf是google提供的一个开源序列化框架，类似于XML，JSON这样的数据表示语言，其最大的特点是基于二进制，因此比传统的XML表示高效短小得多。虽然是二进制数据格式，但并没有因此变得复杂，开发人员通过按照一定的语法定义结构化的消息格式，然后送给命令行工具，工具将自动生成相关的类，可以支持php、j
Protobuf简单示例
look4liming的专栏
06-19 1213
本例以win64为操作系统、Java为开发语言展开。 1、下载Protobuf编译器： 访问页面：https://github.com/protocolbuffers/protobuf/releases，在这个页面找到protoc-3.8.0-win64.zip链接，点击该链接下载Protobuf编译器。 解压该zip文件到当前目录，将当前文件夹下的bin目录的绝对路径配置到系统环境变量...
Protobuf 的简单使用例子
weifc-wei 的博客
03-09 2686
文章目录应用层协议设计protobuf 序列化protobuf的原理定义message编译message文件应用protobufMessage 基本用法Message 嵌套使用具体操作 点击我, 到底部 应用层协议设计 通信双方交换数据的格式与顺序 通信双方应该采取的动作 用户登陆模块 短信获取 获取短信请求 mobile_request 字段名 类型 属性 字段描述 mobile string required 手机号码, 必须为大陆手机取 11 位数字 获取短信响应 m
protobuf 使用简单示例
06-17
Protocol Buffers是Google公司开发的一种数据描述语言，类似于XML能够将结构化数据序列化，可用于数据存储、通信协议等方面。它不依赖于语言和平台并且可扩展性极强。现阶段官方支持C++、JAVA、Python等三种编程语言，但可以找到大量的几乎涵盖所有语言的第三方拓展包。
Protobuf 实例（java）
专注基础架构领域
07-03 463
最近项目中需要使用Protobuf作为设备端到云端通信的数据压缩协议，特此记录便于日后查阅。 protobuf文件名为d_cook_records.proto，内容如下： syntax = "proto3"; import "google/protobuf/any.proto"; // option java_package="com.galanz.iot.content.restapi.model.proto"; option java_outer_classname="DCookRecordsP.
protobuf实例-C#-聊天服务器
07-19
在本实例中，“protobuf实例-C#-聊天服务器”是基于C#语言实现的一个聊天服务项目，利用protobuf进行数据序列化和反序列化，以便于在网络通信中高效地传输聊天消息。 在C#环境下，protobuf提供了编译器工具，可以将...
protobuf实例protobuf-java-2.4.1.jar
09-29
protobuf是Google开发的一种轻量级的数据序列化协议，它允许开发者定义数据结构，然后生成能够序列化和反序列化这些数据的代码。protobuf-java-2.4.1.jar是protobuf的Java实现版本，用于在Java应用程序中处理...
Protobuf应用实例
05-12
**protobuf应用实例——JAVA编解码技术** protobuf（Protocol Buffers）是Google开发的一种数据序列化协议，类似于XML、JSON，但更小巧、高效。它能够将结构化的数据序列化，可用于数据存储、通信协议等方面。在...
Protobuf 3.5应用例子及proto.exe文件
05-19
利用 google protobuf 3.5 将结构化的数据序列化、反序列化应用例子。
protobuf示例参考
02-18
protocol buffers示例参考
protobuf使用案例
04-06
这是一个protobuf入门级使用DEMO，google官方出的序列化和反序列化工具，其性能和字节数都JSON和XML高了不止一个等级，相信通过这个代码，你能很快上手protobuf的使用。
Google protobuf 使用及原理
格赚
12-02 661
简介 什么是 Google Protocol Buffer？ 假如您在网上搜索，应该会得到类似这样的文字介绍： Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准，目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。 Protocol ...
protobuf 简单例子
lvmengzou的专栏
05-20 929
protobuf的简单的例子，如下： person.proto文件 message Person{ required string name = 1; required int32 age = 2; optional string email = 3; enum PhoneType{ MOBILE ...
Protobuf使用实例
Zuoerfeng
11-14 9376
前面章节已经讲述了protobuf的理解，这里直接开门见山，给出一个实，来具体看下是如何使用的。 本案例参考博客： google protobuf安装与使用 案例的主要功能(google提供的基本案例) 该程序示例的大致功能是，定义一个Persion结构体和存放Persion的AddressBook，然后一个写程序向一个文件写入该结构体信息，另一个程序从文件中读出该信息并打印到输出中。 1.add...
Protobuf完整实例
weixin_30337251的博客
04-13 98
地址： http://pan.baidu.com/s/1gfLLavD 密码： v7u9 下载，打开，运行，即可。 转载于:https://www.cnblogs.com/qiywtc/p/5386245.html
protobuf使用例子
gamer
08-27 930
protobuf使用例子
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值