• day30-软件开发规范


    一、为什么要规范软件开发?

    1.1 为什么要有规范软件开发

      之前写的一些程序,所谓的'项目',都是在一个py文件下完成的,代码量也就几百行,没有太大问题。但是真正的后端开发的项目,少则几万行代码,多则十几万,几十万行代码,就不能全都放在一个py文件中了。

      软件开发,规范项目目录结构,代码规范,遵循PEP8规范等等,让代码结构更清晰。

      软件开发的首要规范就是从设计目录结构开始。

    1.2 为什么要设计项目目录结构?

     "设计项目目录结构",就和"代码编码风格"一样,属于个人风格问题。对于这种风格上的规范,一直都存在两种态度:

    一类同学认为,这种个人风格问题"无关紧要"。理由是能让程序work就好,风格问题根本不是问题。
    另一类同学认为,规范化能更好的控制程序结构,让程序具有更高的可读性。
    我是比较偏向于后者的,"项目目录结构"其实也是属于"可读性和可维护性"的范畴,我们设计一个层次清晰的目录结构,就是为了达到以下两点:

    可读性高: 不熟悉这个项目的代码的人,一眼就能看懂目录结构,知道程序启动脚本是哪个,测试目录在哪儿,配置文件在哪儿等等。从而非常快速的了解这个项目。
    可维护性高: 定义好组织规则后,维护者就能很明确地知道,新增的哪个文件和代码应该放在什么目录之下。这个好处是,随着时间的推移,代码/配置的规模增加,项目结构不会混乱。
    所以,保持一个层次清晰的目录结构是有必要的。更何况组织一个良好的工程目录,其实是一件很简单的事儿。

    二、较好的目录结构方式(推荐)

    具体分析:

    #===============>start.py
    # 开启项目的start文件。
    import sys
    import os
    BASE_PATH = os.path.dirname(os.path.dirname(__file__))
    sys.path.append(BASE_PATH)
    from core import src
    
    if __name__ == '__main__':
        src.run()
    
    #===============>settings.py
    # 配置文件,放一些路径或者信息等配置
    import os
    
    BASE_DIR=os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
    DB_PATH=os.path.join(BASE_DIR,'db','db.json')
    LOG_PATH=os.path.join(BASE_DIR,'log','access.log')
    LOGIN_TIMEOUT=5
    
    或
    DB_PATH = r'..db
    egister.py'
    LOG_PATH = r'..logaccess.log'
    
    """
    logging配置
    """
    # 定义三种日志输出格式
    standard_format = '[%(asctime)s][%(threadName)s:%(thread)d][task_id:%(name)s][%(filename)s:%(lineno)d]' 
                      '[%(levelname)s][%(message)s]' #其中name为getlogger指定的名字
    simple_format = '[%(levelname)s][%(asctime)s][%(filename)s:%(lineno)d]%(message)s'
    id_simple_format = '[%(levelname)s][%(asctime)s] %(message)s'
    
    # log配置字典
    LOGGING_DIC = {
        'version': 1,
        'disable_existing_loggers': False,
        'formatters': {
            'standard': {
                'format': standard_format
            },
            'simple': {
                'format': simple_format
            },
        },
        'filters': {},
        'handlers': {
            #打印到终端的日志
            'console': {
                'level': 'DEBUG',
                'class': 'logging.StreamHandler',  # 打印到屏幕
                'formatter': 'simple'
            },
            #打印到文件的日志,收集info及以上的日志
            'default': {
                'level': 'DEBUG',
                'class': 'logging.handlers.RotatingFileHandler',  # 保存到文件
                'formatter': 'standard',
                'filename': LOG_PATH,  # 日志文件
                'maxBytes': 1024*1024*5,  # 日志大小 5M
                'backupCount': 5,
                'encoding': 'utf-8',  # 日志文件的编码,再也不用担心中文log乱码了
            },
        },
        'loggers': {
            #logging.getLogger(__name__)拿到的logger配置
            '': {
                'handlers': ['default', 'console'],  # 这里把上面定义的两个handler都加上,即log数据既写入文件又打印到屏幕
                'level': 'DEBUG',
                'propagate': True,  # 向上(更高level的logger)传递
            },
        },
    }
    
    
    #===============>src.py
    # 主要逻辑部分:
    # 核心逻辑,代码放在这。
    from conf import settings
    from lib import common
    import time
    
    logger=common.get_logger(__name__)
    
    current_user={'user':None,'login_time':None,'timeout':int(settings.LOGIN_TIMEOUT)}
    def auth(func):
        def wrapper(*args,**kwargs):
            if current_user['user']:
                interval=time.time()-current_user['login_time']
                if interval < current_user['timeout']:
                    return func(*args,**kwargs)
            name = input('name>>: ')
            password = input('password>>: ')
            db=common.conn_db()
            if db.get(name):
                if password == db.get(name).get('password'):
                    logger.info('登录成功')
                    current_user['user']=name
                    current_user['login_time']=time.time()
                    return func(*args,**kwargs)
            else:
                logger.error('用户名不存在')
    
        return wrapper
    
    @auth
    def buy():
        print('buy...')
    
    @auth
    def run():
    
        print('''
    购物
    查看余额
    转账
        ''')
        while True:
            choice = input('>>: ').strip()
            if not choice:continue
            if choice == '1':
                buy()
    
    
    
    #===============>db.json
    # 重要数据放在这里
    
    #===============>common.py
    # 公共组件放在这里:公共功能部分。
    from conf import settings
    import logging
    import logging.config
    import json
    
    def get_logger(name):
        logging.config.dictConfig(settings.LOGGING_DIC)  # 导入上面定义的logging配置
        logger = logging.getLogger(name)  # 生成一个log实例
        return logger
    
    
    def conn_db():
        db_path=settings.DB_PATH
        dic=json.load(open(db_path,'r',encoding='utf-8'))
        return dic
    
    
    #===============>access.log
    # 日志信息
    [2017-10-21 19:08:20,285][MainThread:10900][task_id:core.src][src.py:19][INFO][登录成功]
    [2017-10-21 19:08:32,206][MainThread:10900][task_id:core.src][src.py:19][INFO][登录成功]
    [2017-10-21 19:08:37,166][MainThread:10900][task_id:core.src][src.py:24][ERROR][用户名不存在]
    [2017-10-21 19:08:39,535][MainThread:10900][task_id:core.src][src.py:24][ERROR][用户名不存在]
    [2017-10-21 19:08:40,797][MainThread:10900][task_id:core.src][src.py:24][ERROR][用户名不存在]
    [2017-10-21 19:08:47,093][MainThread:10900][task_id:core.src][src.py:24][ERROR][用户名不存在]
    [2017-10-21 19:09:01,997][MainThread:10900][task_id:core.src][src.py:19][INFO][登录成功]
    [2017-10-21 19:09:05,781][MainThread:10900][task_id:core.src][src.py:24][ERROR][用户名不存在]
    [2017-10-21 19:09:29,878][MainThread:8812][task_id:core.src][src.py:19][INFO][登录成功]
    [2017-10-21 19:09:54,117][MainThread:9884][task_id:core.src][src.py:19][INFO][登录成功]
    View Code

    关于README的内容

    每个项目都应该有的一个readme文件,目的是能简要描述该项目的信息,让读者快速了解这个项目。

    它需要说明以下几个事项:
    1、软件定位,软件的基本功能。
    2、运行代码的方法: 安装环境、启动命令等。
    3、简要的使用说明。
    4、代码目录结构说明,更详细点可以说明软件的基本原理。
    5、常见问题说明。

    有以上几点是比较好的一个README。在软件开发初期,由于开发过程中以上内容可能不明确或者发生变化,并不是一定要在一开始就将所有信息都补全。但是在项目完结的时候,是需要撰写这样的一个文档的。

    可以参考Redis源码中Readme的写法,这里面简洁但是清晰的描述了Redis功能和源码结构。

  • 相关阅读:
    模板方法模式
    策略模式
    享元模式
    组合模式
    桥接模式
    外观模式
    代理模式
    装饰者模式
    适配器模式
    类之间的关联关系和依赖关系
  • 原文地址:https://www.cnblogs.com/dxnui119/p/10020177.html
Copyright © 2020-2023  润新知