smartrack-sdk 1.0.0__py3-none-any.whl

examples/callback_server.py

@@ -0,0 +1,435 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+WebAPI回调处理服务器示例
+展示如何使用SmartRack SDK处理WebAPI回调请求
+"""
+
+import logging
+import threading
+import time
+from datetime import datetime
+
+# 导入回调处理器
+from smartrack_sdk.callback import CellEventCallbackService, CellEventHandler
+from smartrack_sdk.models.callback import CellEventHandleRequest, CellEventHandleResponse, CellEventData
+from smartrack_sdk.models.enums import TriggerState, OperationResultCode, LedColors
+
+# 配置日志
+logging.basicConfig(
+    level=logging.INFO,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s'
+)
+logger = logging.getLogger(__name__)
+
+
+class CustomCellEventHandler(CellEventHandler):
+    """自定义储位事件处理器"""
+
+    def handle(self, request: CellEventHandleRequest) -> CellEventHandleResponse:
+        """
+        处理储位事件回调
+
+        Args:
+            request: 回调请求
+
+        Returns:
+            回调响应
+        """
+        logger.info(f"收到储位事件回调 - 用户: {request.user_id}, 客户端: {request.client_id}")
+
+        event_data_list = request.data
+        if not event_data_list:
+            logger.warning("没有事件数据")
+            return CellEventHandleResponse.error(100102, "没有事件数据", request.session_id)
+
+        try:
+            # 处理每个事件
+            for event_data in event_data_list:
+                self._process_cell_event(event_data)
+
+            # 所有事件处理成功
+            return CellEventHandleResponse.success(request.session_id)
+
+        except Exception as e:
+            logger.error("处理事件失败", exc_info=True)
+            return CellEventHandleResponse.error(100103, f"处理事件失败: {str(e)}", request.session_id)
+
+    def _process_cell_event(self, event_data: CellEventData) -> None:
+        """
+        处理单个事件数据
+
+        Args:
+            event_data: 事件数据
+        """
+        logger.info(f"处理事件 - 储位: {event_data.cell_id}, GRN: {event_data.grn}, "
+                   f"状态: {event_data.cell_state.name_en}, 结果: {event_data.code}")
+
+        # 检查操作结果
+        if event_data.code != OperationResultCode.SUCCESS.value:
+            self._handle_operation_error(event_data)
+            return
+
+        # 根据触发状态处理不同操作
+        if event_data.cell_state == TriggerState.PUT_IN:
+            self._handle_put_in_event(event_data)
+        elif event_data.cell_state == TriggerState.TAKE_OUT:
+            self._handle_take_out_event(event_data)
+        else:
+            logger.warning(f"未知的储位状态: {event_data.cell_state}")
+
+    def _handle_put_in_event(self, event_data: CellEventData) -> None:
+        """
+        处理放入事件
+
+        Args:
+            event_data: 事件数据
+        """
+        logger.info(f"处理入库事件 - 储位: {event_data.cell_id}, GRN: {event_data.grn}, 单号: {event_data.sheet_id}")
+
+        # 验证数据
+        if not event_data.grn or not event_data.grn.strip():
+            raise ValueError("GRN不能为空")
+
+        # 这里可以添加具体的入库业务逻辑
+        # 例如：更新数据库记录、发送通知、触发工作流等
+
+        # 模拟业务处理
+        self._update_inventory_for_put_in(event_data)
+        self._send_notification("入库成功", event_data)
+
+        logger.info(f"入库事件处理完成 - 储位: {event_data.cell_id}")
+
+    def _handle_take_out_event(self, event_data: CellEventData) -> None:
+        """
+        处理取出事件
+
+        Args:
+            event_data: 事件数据
+        """
+        logger.info(f"处理出库事件 - 储位: {event_data.cell_id}, GRN: {event_data.grn}, 单号: {event_data.sheet_id}")
+
+        # 验证数据
+        if not event_data.grn or not event_data.grn.strip():
+            raise ValueError("GRN不能为空")
+
+        # 这里可以添加具体的出库业务逻辑
+        # 例如：更新数据库记录、发送通知、触发工作流等
+
+        # 模拟业务处理
+        self._update_inventory_for_take_out(event_data)
+        self._send_notification("出库成功", event_data)
+
+        logger.info(f"出库事件处理完成 - 储位: {event_data.cell_id}")
+
+    def _handle_operation_error(self, event_data: CellEventData) -> None:
+        """
+        处理操作错误
+
+        Args:
+            event_data: 事件数据
+        """
+        logger.error(f"操作错误 - 储位: {event_data.cell_id}, GRN: {event_data.grn}, "
+                    f"错误代码: {event_data.code}, 错误消息: {event_data.message}")
+
+        # 处理不同类型的错误
+        if event_data.code == OperationResultCode.ILLEGAL_STOCK_IN.value:
+            self._handle_illegal_stock_in(event_data)
+        elif event_data.code == OperationResultCode.ILLEGAL_STOCK_OUT.value:
+            self._handle_illegal_stock_out(event_data)
+        elif event_data.code == OperationResultCode.ILLEGAL_STOCK_IN_CLEAR_ERROR.value:
+            self._handle_illegal_stock_in_clear_error(event_data)
+        elif event_data.code == OperationResultCode.ILLEGAL_STOCK_OUT_CLEAR_ERROR.value:
+            self._handle_illegal_stock_out_clear_error(event_data)
+        else:
+            self._handle_unknown_error(event_data)
+
+    # 业务方法实现
+    def _update_inventory_for_put_in(self, event_data: CellEventData) -> None:
+        """更新库存 - 入库"""
+        logger.debug(f"更新库存 - 入库: 储位={event_data.cell_id}, GRN={event_data.grn}")
+        # 实际实现中，这里会更新数据库中的库存记录
+
+    def _update_inventory_for_take_out(self, event_data: CellEventData) -> None:
+        """更新库存 - 出库"""
+        logger.debug(f"更新库存 - 出库: 储位={event_data.cell_id}, GRN={event_data.grn}")
+        # 实际实现中，这里会更新数据库中的库存记录
+
+    def _send_notification(self, message: str, event_data: CellEventData) -> None:
+        """发送通知"""
+        logger.debug(f"发送通知 - 消息: {message}, 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        # 实际实现中，这里会发送邮件、短信或其他通知
+
+    def _handle_illegal_stock_in(self, event_data: CellEventData) -> None:
+        """处理非法上架"""
+        logger.warning(f"非法上架 - 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        self._send_alert("非法上架警告", event_data)
+
+    def _handle_illegal_stock_out(self, event_data: CellEventData) -> None:
+        """处理非法下架"""
+        logger.warning(f"非法下架 - 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        self._send_alert("非法下架警告", event_data)
+
+    def _handle_illegal_stock_in_clear_error(self, event_data: CellEventData) -> None:
+        """处理非法上架清错"""
+        logger.warning(f"非法上架清错 - 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        self._send_alert("非法上架清错警告", event_data)
+
+    def _handle_illegal_stock_out_clear_error(self, event_data: CellEventData) -> None:
+        """处理非法下架清错"""
+        logger.warning(f"非法下架清错 - 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        self._send_alert("非法下架清错警告", event_data)
+
+    def _handle_unknown_error(self, event_data: CellEventData) -> None:
+        """处理未知错误"""
+        logger.error(f"未知错误 - 储位: {event_data.cell_id}, GRN: {event_data.grn}, "
+                    f"错误代码: {event_data.code}")
+        self._send_alert("未知错误警告", event_data)
+
+    def _send_alert(self, alert_type: str, event_data: CellEventData) -> None:
+        """发送告警通知"""
+        logger.debug(f"发送告警 - 类型: {alert_type}, 储位: {event_data.cell_id}, GRN: {event_data.grn}")
+        # 实际实现中，这里会发送告警邮件、短信或其他通知
+
+
+def demonstrate_callback_processing():
+    """演示回调处理"""
+    logger.info("=== 演示回调处理 ===")
+
+    # 创建自定义处理器
+    handler = CustomCellEventHandler()
+
+    # 创建模拟请求
+    request = CellEventHandleRequest()
+    request.user_id = "demo-user"
+    request.client_id = "demo-client"
+    request.session_id = f"demo-session-{int(datetime.now().timestamp())}"
+
+    # 创建事件数据
+    event_data = CellEventData()
+    event_data.code = OperationResultCode.SUCCESS.value
+    event_data.message = "入库成功"
+    event_data.cell_id = "A0010001"
+    event_data.cell_state = TriggerState.PUT_IN
+    event_data.grn = "DEMO-PRODUCT-001"
+    event_data.sheet_id = "DEMO-SHEET-001"
+    event_data.led_color = LedColors.GREEN
+    event_data.is_blink = False
+    event_data.rack_id = "A001"
+
+    request.add_event_data(event_data)
+
+    # 处理回调
+    response = handler.handle(request)
+
+    # 显示结果
+    logger.info(f"回调处理结果: 代码={response.code}, 消息={response.message}")
+
+    if response.is_success:
+        logger.info("回调处理成功!")
+    else:
+        logger.error(f"回调处理失败: {response.message}")
+
+
+def demonstrate_error_handling():
+    """演示错误处理"""
+    logger.info("=== 演示错误处理 ===")
+
+    handler = CustomCellEventHandler()
+
+    # 创建包含错误的请求
+    request = CellEventHandleRequest()
+    request.user_id = "demo-user"
+    request.client_id = "demo-client"
+    request.session_id = f"demo-session-{int(datetime.now().timestamp())}"
+
+    # 创建错误事件数据
+    event_data = CellEventData()
+    event_data.code = OperationResultCode.ILLEGAL_STOCK_IN.value
+    event_data.message = "非法上架"
+    event_data.cell_id = "A0010001"
+    event_data.cell_state = TriggerState.PUT_IN
+    event_data.grn = "DEMO-PRODUCT-001"
+    event_data.led_color = LedColors.RED
+    event_data.is_blink = True
+    event_data.rack_id = "A001"
+
+    request.add_event_data(event_data)
+
+    # 处理回调
+    response = handler.handle(request)
+
+    # 显示结果
+    logger.info(f"错误处理结果: 代码={response.code}, 消息={response.message}")
+    logger.info("即使有错误，回调处理仍然成功完成")
+
+
+def start_callback_server(host: str = "0.0.0.0", port: int = 8080):
+    """启动回调服务器"""
+    try:
+        # 尝试导入Flask
+        from flask import Flask, request, jsonify
+        FLASK_AVAILABLE = True
+    except ImportError:
+        FLASK_AVAILABLE = False
+
+    if FLASK_AVAILABLE:
+        _start_flask_server(host, port)
+    else:
+        logger.error("Flask不可用，请安装: pip install Flask")
+        logger.info("您可以使用以下方式手动处理回调:")
+        _show_manual_callback_setup()
+
+
+def _start_flask_server(host: str, port: int):
+    """启动Flask服务器"""
+    from flask import Flask, request, jsonify
+
+    app = Flask(__name__)
+    app.config['JSON_AS_ASCII'] = False
+
+    # 创建事件处理器
+    handler = CustomCellEventHandler()
+
+    @app.route('/api/SmartRack/CellEventHandle', methods=['POST'])
+    def handle_cell_event():
+        """处理储位事件回调"""
+        try:
+            # 获取请求数据
+            request_data = request.get_json()
+            if not request_data:
+                return jsonify({
+                    'code': 100100,
+                    'message': '请求数据为空',
+                    'sessionId': '',
+                    'timestamp': datetime.now().isoformat()
+                }), 400
+
+            # 创建回调请求对象
+            callback_request = CellEventHandleRequest.from_dict(request_data)
+            logger.info(f"收到储位事件回调: {callback_request}")
+
+            # 处理事件
+            response = handler.handle(callback_request)
+
+            # 返回响应
+            return jsonify(response.to_dict())
+
+        except Exception as e:
+            logger.error("处理储位事件回调时发生错误", exc_info=True)
+            return jsonify({
+                'code': 100101,
+                'message': f'处理回调时发生错误: {str(e)}',
+                'sessionId': '',
+                'timestamp': datetime.now().isoformat()
+            }), 500
+
+    @app.route('/api/SmartRack/health', methods=['GET'])
+    def health():
+        """健康检查接口"""
+        return jsonify({
+            'status': 'ok',
+            'message': 'SmartRack Callback Service is running',
+            'timestamp': datetime.now().isoformat()
+        })
+
+    @app.route('/', methods=['GET'])
+    def index():
+        """首页"""
+        return jsonify({
+            'service': 'SmartRack Callback Service',
+            'version': '1.0.0',
+            'endpoints': {
+                'callback': '/api/SmartRack/CellEventHandle',
+                'health': '/api/SmartRack/health'
+            },
+            'timestamp': datetime.now().isoformat()
+        })
+
+    logger.info(f"启动Flask服务器 - 地址: {host}:{port}")
+    logger.info("回调端点: POST http://{}:{}/api/SmartRack/CellEventHandle".format(host, port))
+    logger.info("健康检查: GET http://{}:{}/api/SmartRack/health".format(host, port))
+
+    # 在单独的线程中启动服务器
+    def run_server():
+        app.run(host=host, port=port, debug=False, threaded=True)
+
+    server_thread = threading.Thread(target=run_server, daemon=True)
+    server_thread.start()
+
+    return server_thread
+
+
+def _show_manual_callback_setup():
+    """显示手动回调设置说明"""
+    logger.info("=== 手动回调设置说明 ===")
+    logger.info("1. 使用其他Web框架（如FastAPI、Django等）")
+    logger.info("2. 实现HTTP POST接口: /api/SmartRack/CellEventHandle")
+    logger.info("3. 使用CustomCellEventHandler处理请求")
+    logger.info("4. 返回JSON格式的响应")
+    logger.info("")
+    logger.info("示例Flask代码:")
+    logger.info("""
+from flask import Flask, request, jsonify
+from smartrack_sdk.callback import CustomCellEventHandler
+
+app = Flask(__name__)
+handler = CustomCellEventHandler()
+
+@app.route('/api/SmartRack/CellEventHandle', methods=['POST'])
+def handle_cell_event():
+    data = request.get_json()
+    callback_request = CellEventHandleRequest.from_dict(data)
+    response = handler.handle(callback_request)
+    return jsonify(response.to_dict())
+    """)
+
+
+def main():
+    """主函数"""
+    logger.info("SmartRack WebAPI回调处理示例")
+    logger.info("=" * 50)
+
+    # 演示回调处理
+    demonstrate_callback_processing()
+    logger.info("")
+
+    # 演示错误处理
+    demonstrate_error_handling()
+    logger.info("")
+
+    # 显示服务器启动选项
+    logger.info("启动WebAPI回调服务器选项:")
+    logger.info("1. 启动内置Flask服务器: python callback_server.py --server")
+    logger.info("2. 查看手动设置说明: python callback_server.py --manual")
+    logger.info("")
+
+    # 检查命令行参数
+    import sys
+    if len(sys.argv) > 1:
+        if sys.argv[1] == "--server":
+            logger.info("启动Flask回调服务器...")
+            try:
+                start_callback_server()
+                logger.info("服务器已启动，按Ctrl+C停止")
+
+                # 保持服务器运行
+                try:
+                    while True:
+                        time.sleep(1)
+                except KeyboardInterrupt:
+                    logger.info("服务器已停止")
+            except Exception as e:
+                logger.error(f"启动服务器失败: {e}")
+        elif sys.argv[1] == "--manual":
+            _show_manual_callback_setup()
+        else:
+            logger.error(f"未知参数: {sys.argv[1]}")
+    else:
+        logger.info("使用参数启动服务器: python callback_server.py --server")
+        logger.info("或查看手动设置: python callback_server.py --manual")
+
+
+if __name__ == "__main__":
+    main()