diff --git a/DeployDevice/doc/ReadMe b/DeployDevice/doc/ReadMe index aa6221d9d1dece2e551fb6c393747dc83ded0ee6..de74508b679b0f97c697b65b42677c7028495b37 100644 --- a/DeployDevice/doc/ReadMe +++ b/DeployDevice/doc/ReadMe @@ -1,41 +1,41 @@ -一、代码规范: - module_name, 模块名, 如果模块里面没有定义类,直接引用方法,则采用ModuleName方式命名 - package_name, 包名 - ClassName, 类名 - method_name, 方法名 - ExceptionName, 异常 - function_name, 函数 - GLOBAL_VAR_NAME, 全局变量 - instance_var_name, 实例 - function_parameter_name, 参数名 - local_var_name, 局部变量名 +涓銆佷唬鐮佽鑼冿細 + module_name, 妯″潡鍚, 濡傛灉妯″潡閲岄潰娌℃湁瀹氫箟绫伙紝鐩存帴寮曠敤鏂规硶锛屽垯閲囩敤ModuleName鏂瑰紡鍛藉悕 + package_name, 鍖呭悕 + ClassName, 绫诲悕 + method_name, 鏂规硶鍚 + ExceptionName, 寮傚父 + function_name, 鍑芥暟 + GLOBAL_VAR_NAME, 鍏ㄥ眬鍙橀噺 + instance_var_name, 瀹炰緥 + function_parameter_name, 鍙傛暟鍚 + local_var_name, 灞閮ㄥ彉閲忓悕11 -二、 代码架构: +浜屻 浠g爜鏋舵瀯锛 -三、 目录结构: +涓夈 鐩綍缁撴瀯锛 EnvServiceInBlue/src - aw:原子方法。目录以及文件名采用首字母大写的驼峰字符串 - exception: 异常处理类,以及错误码信息等 - function: 核心功能代码,制作业务的最基础功能,不串联整个业务流程 - send_data: 数据发送相关 - func 每个独立功能服务,升级和部署都是独立的app,能串联起某项业务的整个流程 - core 框架, 执行器,负责串联多个func - util 一些公共的方法 - init.py 框架初始化的准备工作 - Manage.py:服务入口。 + aw锛氬師瀛愭柟娉曘傜洰褰曚互鍙婃枃浠跺悕閲囩敤棣栧瓧姣嶅ぇ鍐欑殑椹煎嘲瀛楃涓 + exception: 寮傚父澶勭悊绫伙紝浠ュ強閿欒鐮佷俊鎭瓑 + function: 鏍稿績鍔熻兘浠g爜锛屽埗浣滀笟鍔$殑鏈鍩虹鍔熻兘锛屼笉涓茶仈鏁翠釜涓氬姟娴佺▼ + send_data: 鏁版嵁鍙戦佺浉鍏 + func 姣忎釜鐙珛鍔熻兘鏈嶅姟,鍗囩骇鍜岄儴缃查兘鏄嫭绔嬬殑app,鑳戒覆鑱旇捣鏌愰」涓氬姟鐨勬暣涓祦绋 + core 妗嗘灦, 鎵ц鍣紝璐熻矗涓茶仈澶氫釜func + util 涓浜涘叕鍏辩殑鏂规硶 + init.py 妗嗘灦鍒濆鍖栫殑鍑嗗宸ヤ綔 + Manage.py锛氭湇鍔″叆鍙c -四、代码设计要求: - 1、 业务功能代码以及异常处理逻辑代码等都集中exception,excute,function, tools包下 - 2、 代码编写严格按照包的划分来进行,要求excute和function两个包中的代码功能单一。 - 3、 框架为django,要求业务功能代码完全脱离django框架能独立调用,并也可在main.py中通过django框架调用。 - 4、 Env_tools目录下新增一个agent包,存放pika方案调用的python文件,保证能在一台代码下,支持web和pika微服务两种调用。 +鍥涖佷唬鐮佽璁¤姹傦細 + 1銆 涓氬姟鍔熻兘浠g爜浠ュ強寮傚父澶勭悊閫昏緫浠g爜绛夐兘闆嗕腑exception锛宔xcute锛宖unction锛 tools鍖呬笅 + 2銆 浠g爜缂栧啓涓ユ牸鎸夌収鍖呯殑鍒掑垎鏉ヨ繘琛岋紝瑕佹眰excute鍜宖unction涓や釜鍖呬腑鐨勪唬鐮佸姛鑳藉崟涓銆 + 3銆 妗嗘灦涓篸jango锛岃姹備笟鍔″姛鑳戒唬鐮佸畬鍏ㄨ劚绂籨jango妗嗘灦鑳界嫭绔嬭皟鐢紝骞朵篃鍙湪main.py涓氳繃django妗嗘灦璋冪敤銆 + 4銆 Env_tools鐩綍涓嬫柊澧炰竴涓猘gent鍖咃紝瀛樻斁pika鏂规璋冪敤鐨刾ython鏂囦欢锛屼繚璇佽兘鍦ㄤ竴鍙颁唬鐮佷笅锛屾敮鎸亀eb鍜宲ika寰湇鍔′袱绉嶈皟鐢ㄣ -五、代码提交命令: +浜斻佷唬鐮佹彁浜ゅ懡浠わ細 git add -A git commit -m "TicketNo:None - Description:说明 + Description:璇存槑 Feature or Bugfix:Feature" git push origin EnvTool_master:refs/for/EnvTool_master