Django笔记

一、总体介绍

1、Django的基本知识

1）优缺点

（1）优点：python实现，代码干净、整洁；提供管理后台，能够快速开发；复用度高，设计、使用上遵循DRY原则；易于扩展复用的中间件；内置的安全框架；丰富的第三方类库；

（2）缺点：单体应用-不易并行开发、单点扩展；不适合非常小的几行代码的项目；不适合高并发的To C互联网项目

2）Django的MTV架构

3）Django的涉及思想

DRY（don't repeat yourself）:不重复造轮子；MVT；快速开发；灵活易于扩展；松耦合；显示优于隐式；

2、创建第一个Django项目

1）流程

#创建项目
django-admin startproject projectname
#启动项目
python manage.py runserver 0.0.0.0:8080
#访问项目
http://127.0.0.1:8080
#数据库迁移
python manage.py makemigrations
python manage.py migrate

 2）创建管理员账号

python manage.py createsuperuser admin

 3）创建app

python manage.py startapp appname

4）models.py

# Create your models here.
class Host(models.Model):  # 主机
    projectname = models.ForeignKey(Project, on_delete=models.CASCADE, verbose_name="系统名称")
    applicationname = models.CharField(max_length=516, default="none", verbose_name="系统别称")
    ipaddr = models.CharField(max_length=32, verbose_name="IP地址")
    servicename = models.CharField(max_length=64, default="none", verbose_name="服务名|发布包名")
    create_time = models.DateTimeField(auto_now_add=True, verbose_name="创建时间")

    class Meta:
        # 多列唯一索引
        unique_together = ('ipaddr', 'servicename')

    class Meta:
        verbose_name = "主机表"
    #python2
    def __unicode__(self):
        return self.servicename + '-' + self.ipaddr
    #python3
    def __str__(self):
        return self.servicename + '-' + self.ipaddr

5）admin.py

class OvertimeAlertAdmin(admin.ModelAdmin):
    # admin页面显示字段
    list_display = (
        'projectid', 'type', 'info', 'due_time', 'notify_emaila', 'notify_emailb', 'notified',
        'alert_day',
        'is_valid', 'is_mailed',)
    # admin页面搜索字段
    search_fields = ('notify_emaila',)
    # admin页面刷选字段
    list_filter = ('notify_emaila',)
    # admin页面不显示字段
    exclude = ('last_notified_time')

    # 自动保存自动
    def save_model(self, request, obj, form, change):
        obj.user = request.user
        super().save_model(request, obj, form, change)

    # 分组展示
    fieldsets = (
        (None, {'fields': ('type', 'info', 'due_time', ('notify_emaila', 'notify_emailb'))}),
    )

 6）Django的自定义模板

（1）Django模板包含了输出的HTML页面的静态部分的内容

（2）模板里面的动态内容再运行时被替换

（3）在views里面指定了每个URL使用哪个模板来渲染页面

（4）模板继承与块（Template Inheritance & Block）

　　模板继承容许定义一个骨架模板，骨架包含站点上的公共元素（如头部导航，尾部链接）

　　骨架模板里面可以定义Block块，每一个Block块都可以在继承的页面上重新定义/覆盖

　　一个页面可以继承自另一个页面

（5）定义一个匿名访问页面的基础页面，基础页面中定义页头

（6）添加页面appname/templates/base.html

　　block指定定义了页面内容块，块的名称为content，这个块可以在继承的页面中重新定义。

　　extents指定了继承。

 

3、迭代思维与MVP产品规划方法（OOPD）

 1）基本定义

（1）MVP：minimum viable product，最小可用产品

（2）OOPD：Online & Offline Product Development，线上线下相结合的产品开发方法

　　内裤原则：MVP包含了产品的轮廓，核心的功能，让业务可以运转；

　　优先线下：能够走线下的，优先走线下流程，让核心的功能先跑起来，快速做 用户验证和方案验证；

　　MVP的核心：忽略掉一切的细枝末节，做合适的假设和简化，使用最短的时间开发处理

（3）迭代思维是最强大的产品思维逻辑，互联网上唯快不破的秘诀

（4）优秀的工程师和优秀的产品经理，善于找出产品MVP的功能范围

4、企业级数据库设计十个原则

1）3个基础原则

（1）结构清晰：表名、字段命令没有歧义，能一眼看懂

（2）唯一职责：一表一用，领域定义清晰，不存储无关信息，相关数据在一张表中

（3）主键原则：设计不带物理意义的主键；有唯一约束，确保幂等

2）4个扩展性原则

（1）长短分离：可以扩展，长文本独立存储；有合适的容量设计；

（2）冷热分离：当前数据与历史数据分离；

（3）索引完备：有合适索引方便查询；

（4）不使用关联查询：不使用一切的SQL Join操作，不做2个表或者更多表的关联查询

3）3个完备性原则

（1）完整性：保证数据的准确性和完整性，重要的内容都有记录；

（2）可追溯：可追溯创建时间，修改时间，可以逻辑删除；

（3）一致性原则：数据之间保持一致，尽可能避免同样的数据存储在不同表中。

二、基本功能

1、实现数据导入

1）怎样实现一个数据导入的功能最简洁

　　开发一个自定义的web页面，让用户能够上传excel/csv文件

　　开发一个命令行工具，读取excel/csv，再访问数据库导入DB

　　从数据库的客户端，比如Mysql的客户端里面导入数据

2）Django命令行场景

（1）使用自定义的django management命令行来导入数据

（2）应用下面创建management/commands目录

（3）commands目录下添加脚本，创建类，继承自BaseCommand，实现命令行逻辑

import csv
from django.core.management import BaseCommand
from interview.models import Candidate

# run command to import candidates:
# python manage.py import_candidates --path /path/to/your/file.csv


class Command(BaseCommand):
    help = '从一个CSV文件的内容中读取候选人列表，导入到数据库中'

    def add_arguments(self, parser):
        parser.add_argument('--path', type=str)

    def handle(self, *args, **kwargs):
        path = kwargs['path']
        with open(path, 'rt', encoding="gbk") as f:
            reader = csv.reader(f, dialect='excel', delimiter=';')
            for row in reader:

                candidate = Candidate.objects.create(
                    username=row[0],
                    city=row[1],
                    phone=row[2],
                    bachelor_school=row[3],
                    major=row[4],
                    degree=row[5],
                    test_score_of_general_ability=row[6],
                    paper_score=row[7]
                )

                print(candidate)

（4）运行：

python manage.py import_datas --path /path/to/your/file.csv

2、企业域账号集成

1）安装django_python3_ldap

pip install django-python3-ldap

 2）添加django_python3_ldap应用

setting.py->INSTALLED_APPS 添加django_python3_ldap

 3）配置django_python3_ldap应用

### LDAP 

# The URL of the LDAP server.
LDAP_AUTH_URL = "ldap://localhost:389"
# Initiate TLS on connection.
LDAP_AUTH_USE_TLS = False

# The LDAP search base for looking up users.
LDAP_AUTH_SEARCH_BASE = "dc=ihopeit,dc=com"
# The LDAP class that represents a user.
LDAP_AUTH_OBJECT_CLASS = "inetOrgPerson"

# User model fields mapped to the LDAP
# attributes that represent them.
LDAP_AUTH_USER_FIELDS = {
    "username": "cn",
    "first_name": "givenName",
    "last_name": "sn",
    "email": "mail",
}

# A tuple of django model fields used to uniquely identify a user.
LDAP_AUTH_USER_LOOKUP_FIELDS = ("username",)

# Path to a callable that takes a dict of {model_field_name: value},
# returning a dict of clean model data.
# Use this to customize how data loaded from LDAP is saved to the User model.
LDAP_AUTH_CLEAN_USER_DATA = "django_python3_ldap.utils.clean_user_data"

# The LDAP username and password of a user for querying the LDAP database for user
# details. If None, then the authenticated user will be used for querying, and
# the `ldap_sync_users` command will perform an anonymous query.
LDAP_AUTH_CONNECTION_USERNAME = None
LDAP_AUTH_CONNECTION_PASSWORD = None

AUTHENTICATION_BACKENDS = {"django_python3_ldap.auth.LDAPBackend",'django.contrib.auth.backends.ModelBackend',}

 4）从 Open LDAP/AD 中导入账号信息

python manage.py ladp_sync_users

3、增加自定义的数据操作菜单 （数据导出为 CSV）

场景：需要对数据进行操作，比如导出，状态变更 （如 标记候选人为 “待面试”）

1）在admin.py中定义按钮的实现逻辑（处理函数）

exportable_fields = ('username', 'city', 'phone', 'bachelor_school', 'master_school', 'degree', 'first_result', 'first_interviewer_user',
                     'second_result', 'second_interviewer_user', 'hr_result', 'hr_score', 'hr_remark', 'hr_interviewer_user')


# define export action
def export_model_as_csv(modeladmin, request, queryset):
    response = HttpResponse(content_type='text/csv')
    field_list = exportable_fields
    response['Content-Disposition'] = 'attachment; filename=%s-list-%s.csv' % (
        'recruitment-candidates',
        datetime.now().strftime('%Y-%m-%d-%H-%M-%S'),
    )

    # 写入表头
    writer = csv.writer(response)
    writer.writerow(
        [queryset.model._meta.get_field(f).verbose_name.title() for f in field_list],
    )

    for obj in queryset:
        ## 单行 的记录（各个字段的值）， 根据字段对象，从当前实例 (obj) 中获取字段值
        csv_line_values = []
        for field in field_list:
            field_object = queryset.model._meta.get_field(field)
            field_value = field_object.value_from_object(obj)
            csv_line_values.append(field_value)
        writer.writerow(csv_line_values)
    logger.error(" %s has exported %s candidate records" % (request.user.username, len(queryset)))

    return response


export_model_as_csv.short_description = u'导出为CSV文件'

export_model_as_csv.allowed_permissions = ('export',)

 2）在admin.py的 ModelAdmin 中注册函数到 actions

# 候选人管理类
class CandidateAdmin(admin.ModelAdmin):
    #。。。

    actions = (export_model_as_csv, )
    #。。。

4、日志记录

1）四个组件

（1）Loggers：日志记录的处理类/对象，一个 Logger 可以有多个 Handlers

（2）Handlers：对于每一条日志消息如何处理，记录到 文件，控制台，还是网络

（3）Filters： 定义过滤器，用于 Logger/Handler 之上

（4）Formmaters: 定义日志文本记录的格式

2）五个日志级别

（1）DEBUG: 调试

（2）INFO: 常用的系统信息

（3）WARNING: 小的告警，不影响主要功能

（4）ERROR: 系统出现不可忽视的错误

（5）CRITICAL: 非常严重的错误

 3）使用日志记录

import logging

logger= logging.getLogger(__name__)

def my_view(request):
    if False:
        logger.error("my_view false")

 4）配置日志记录

Django 里面使用 dictConfig 格式来配置日志。

Dictionary 对象，至少包含如下内容：

version, 目前唯一有效的值是 1 ；

Handler, logger 是可选内容，通常需要自己定义；

Filter, formatter 是可选内容，可以不用定义；

定义日志输出格式， 分别定义 全局日志记错， 错误日志处理， 自定义的 日志处理器。

# 配置日志
cur_path = os.path.dirname(os.path.realpath(__file__))  # log_path是存放日志的路径
log_path = os.path.join(os.path.dirname(cur_path), 'logs')
if not os.path.exists(log_path): os.mkdir(log_path)  # 如果不存在这个logs文件夹，就自动创建一个

# LOGGING_CONFIG=None #禁用

LOGGING = {
    'version': 1,
    'disable_existing_loggers': True,
    'formatters': {
        # 日志格式
        'standard': {
            'format': '[%(asctime)s] [%(filename)s:%(lineno)d] [%(module)s:%(funcName)s] '
                      '[%(levelname)s]- %(message)s'},
        'simple': {  # 简单格式
            'format': '%(levelname)s %(message)s'
        },
    },
    # 过滤
    'filters': {
    },
    # 定义具体处理日志的方式
    'handlers': {
        # 默认记录所有日志
        'default': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'all-{}.log'.format(time.strftime('%Y-%m-%d'))),
            'maxBytes': 1024 * 1024 * 5,  # 文件大小
            'backupCount': 5,  # 备份数
            'formatter': 'standard',  # 输出格式
            'encoding': 'utf-8',  # 设置默认编码，否则打印出来汉字乱码
        },
        # 输出错误日志
        'error': {
            'level': 'ERROR',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'error-{}.log'.format(time.strftime('%Y-%m-%d'))),
            'maxBytes': 1024 * 1024 * 5,  # 文件大小
            'backupCount': 5,  # 备份数
            'formatter': 'standard',  # 输出格式
            'encoding': 'utf-8',  # 设置默认编码
        },
        # 控制台输出
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
            'formatter': 'standard'
        },
        # 输出info日志
        'info': {
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(log_path, 'info-{}.log'.format(time.strftime('%Y-%m-%d'))),
            'maxBytes': 1024 * 1024 * 5,
            'backupCount': 5,
            'formatter': 'standard',
            'encoding': 'utf-8',  # 设置默认编码
        },
    },
    # 配置用哪几种 handlers 来处理日志
    'loggers': {
        # 类型 为 django 处理所有类型的日志， 默认调用
        'django': {
            'handlers': ['default', 'console'],
            'level': 'INFO',
            'propagate': False
        },
        # log 调用时需要当作参数传入
        'log': {
            'handlers': ['error', 'info', 'console', 'default'],
            'level': 'INFO',
            'propagate': True
        },
    }
}

5、生产环境与开发环境配置分离

问题：

生产环境的配置与开发环境配置隔离开， 开发环境允许 Debugging 

敏感信息不提交到代码库中，比如数据库连接，secret key, LDAP连接信息等

生产、开发环境使用的配置可能不一样，比如 分别使用 MySQL/Sqlite 数据库

1）步骤

（1）把 settings.py 抽出来，创建3个配置文件

base.py 基础配置； local.py 本地开发环境配置，允许 Debug； production.py 生产环境配置， 不进到 代码库版本控制。

（2）命令行启动时指定环境配置 

 python ./manage.py runserver 127.0.0.1:8000 --settings=settings.local 

使得 manage.py 中的如下代码失效： os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings.base')

6、更美观的管理后台：替换Django admin的主题风格

 1）步骤

（1）安装 django-grappelli 风格 ：pip install django-grappelli 

（2）settings.py 中配置 ： INSTALLED_APPS = ( 'grappelli', 'django.contrib.admin', )

（3）urls.py 中添加 URL 映射 urlpatterns = [ path('grappelli/', include('grappelli.urls')), path('admin/', admin.site.urls), # admin site ]

7、集成 registration，允许用户注册登陆

 1）步骤

（1）安装 registration ：pip install django-registration-redux 

（2）添加到 apps 和url中

INSTALLED_APPS = [
    'registration',
]

urlpatterns = [
    path('accounts/', include('registration.backends.simple.urls')), 
]

（3）同步数据库

（4）添加登陆，退出链接到页面中

 8、为已有数据库生成管理后台

 1）步骤

（1）创建项目： $ django-admin startproject empmanager

（2）编辑 settings.py 中的数据库配置vim ~/settings.py

DATABASES = { 
    'default’: { 
    'ENGINE': 'django.db.backends.mysql', 'NAME': 'mydatabase', 
    'USER': 'mydatabaseuser', 'PASSWORD': 'mypassword', 'HOST': '127.0.0.1', 'PORT': 
    '5432', 
    }
}

（3）生成 model 类

./manage.py inspectdb > models.py

 

 

 

 

 参考：

1、Django快速开发实战