Django 项目流程

准备项目代码仓库

1.源码托管网站

• 码云
• github

2.在代码托管网站创建源码远程空仓库：

• 创建远程dev分支
• 配置SSH公钥：Linux位于"用户目录/.ssh/id_rsa.pu"内

克隆项目代码仓库

1. 指定本地项目目录内克隆项目
$ git clone https://gitee.com/XXXXXXXXX.git
2. 创建dev分支

• 克隆服务器端的分支并跟踪：
  git checkout -b dev origin/dev
• 创建自己的本地分支：
  checkout -b my_dev

3.创建项目虚拟环境，安装Django框架
mkvirtualenv -p python3 env_name
pip install django==1.11.11
4. 在本地分支上创建Django工程
django-admin startproject project_name

配置开发环境

1. 新建配置文件

1. 准备配置文件目录

   • 在工程同名目录下，新建包，命名为settings，作为配置文件目录

2. 准备开发和生产环境配置文件

   • 在配置包settings中，新建开发和生产环境配置文件（不同配置文件可用于开发/测试/上线环境）

3. 准备开发环境配置内容

   • 将默认的配置文件settings.py中内容拷贝至dev.py,并删除原settings文件

     
     image.png

4. 指定开发环境配置文件

在manage.py中修改默认使用的配置文件：

image.png

创建模板文件夹

在工程同名目录下创建模板文件夹，命名templates,该目录名必须为templates，不可改变。

创建utils工具包

• 在工程同名目录下创建utils包单独用来存放工具类、自定义模块及第三方代码，如jinja2的环境配置文件
• 创建Jinja2模板引擎环境配置文件jinja2_env.py
  image.png

添加代码如下：

from jinja2 import Environment
from django.contrib.staticfiles.storage import staticfiles_storage
from django.urls import reverse


def jinja2_environment(**options):
   env = Environment(**options)
   env.globals.update({
       'static': staticfiles_storage.url,
       'url': reverse,
   })
   return env

配置Jinja2模板引擎

1. 安装Jinja2扩展包
   在当前虚拟环境下：

pip install Jinja2

2. 配置Jinja2模板引擎
   在当前使用的dev设置文件下修改TEMPLATES配置：

• 第一行BACKEND项修改模板引擎为jinja2
• 第二行添加上面创建的templates模板文件夹路径
• 最后内容行加载Jinja2模板环境变量

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.jinja2.Jinja2',  # jinja2模板引擎
        'DIRS': [os.path.join(BASE_DIR, 'templates')],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
            # 补充Jinja2模板引擎环境
            'environment': 'meiduo_mall.utils.jinja2_env.jinja2_environment', 
        },
    },
]

配置MySQL数据库

1. 安装并设置PyMySQL扩展包

pip install pymysql

2.在工程同名子目录的init.py文件中，添加如下代码：

from pymysql import install_as_MySQLdb

install_as_MySQLdb()

3. 在当前使用的设置文件dev.py下，修改DATABASE：

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql', # 数据库引擎
        'HOST': '127.0.0.1', # 数据库主机
        'PORT': 3306, # 数据库端口
        'USER': 'root', # 数据库用户名
        'PASSWORD': '123456', # 数据库用户密码
        'NAME': 'meiduo' # 数据库名字
    },
}

配置Redis数据库

使用redis来储存后期的验证码及session等缓存文件。

1. 安装django-redis扩展包

pip install django-redis

2. 配置Redis数据库

• 在当前使用的设置文件dev.py中添加CACHES设置：

CACHES = {
    "default": { # 默认
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/0",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
    "session": { # session
        "BACKEND": "django_redis.cache.RedisCache",
        "LOCATION": "redis://127.0.0.1:6379/1",
        "OPTIONS": {
            "CLIENT_CLASS": "django_redis.client.DefaultClient",
        }
    },
}
SESSION_ENGINE = "django.contrib.sessions.backends.cache"
SESSION_CACHE_ALIAS = "session"

配置工程文件

1. 创建日志文件目录
   在manage.py同级目录下，创建目录logs存放日志文件。

   • logs文件同样需要被git管理，但不应上传log目录下的.log文件。
   • 将*.log添加至忽略文件

   • 在log目录下创建空文件.gitkeep，使log目录能被git管理，否则git不会管理空目录。

     
     image.png

2. 配置工程日志
   dev.py设置文件中添加：

LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,  # 是否禁用已经存在的日志器
    'formatters': {  # 日志信息显示的格式
        'verbose': {
            'format': '%(levelname)s %(asctime)s %(module)s %(lineno)d %(message)s'
        },
        'simple': {
            'format': '%(levelname)s %(module)s %(lineno)d %(message)s'
        },
    },
    'filters': {  # 对日志进行过滤
        'require_debug_true': {  # django在debug模式下才输出日志
            '()': 'django.utils.log.RequireDebugTrue',
        },
    },
    'handlers': {  # 日志处理方法
        'console': {  # 向终端中输出日志
            'level': 'INFO',
            'filters': ['require_debug_true'],
            'class': 'logging.StreamHandler',
            'formatter': 'simple'
        },
        'file': {  # 向文件中输出日志
            'level': 'INFO',
            'class': 'logging.handlers.RotatingFileHandler',
            'filename': os.path.join(os.path.dirname(BASE_DIR), 'logs/meiduo.log'),  # 日志文件的位置
            'maxBytes': 300 * 1024 * 1024,
            'backupCount': 10,
            'formatter': 'verbose'
        },
    },
    'loggers': {  # 日志器
        'django': {  # 定义了一个名为django的日志器
            'handlers': ['console', 'file'],  # 可以同时向终端与文件中输出日志
            'propagate': True,  # 是否继续传递日志信息
            'level': 'INFO',  # 日志器接收的最低日志级别
        },
    }
}

配置静态文件

1. 创建静态文件目录
   在工程同名子目录中，创建目录static
   

   image.png

2. 指定静态文件加载路径
   在当前设置文件dev.py中添加静态文件路径设置

STATIC_URL = '/static/'

# 配置静态文件加载路径
STATICFILES_DIRS = [os.path.join(BASE_DIR, 'static')]

创建app路径

为了工程app的管理，这里不应把app目录直接创建在manage.py同级的目录中。

• 在工程同名子目录中，创建包，名为apps
  image.png
• 需要创建应用时，创建位置在该apps内
• 创建方式：cd到该apps路径下：
  python3 ../../manage.py startapp appname
  注：manage.py不在相同目录，需要使用../../找到它。

追加导包路径

由于自定义app存放路径，使目录结构的变更，当我们需要在设置文件中注册app时，需要输入更长的路径。

• 为了更方便的应用模块，可以追加导包路径。
• sys.path下即为python的导包路径列表，python会先在当前目录查找导包，如没有，再按顺序在sys.path的列表路径下查找。
• 在当前设置文件dev.py中：
  添加apps目录至导包路径

import sys
sys.path.insert(0,os.path.join(BASE_DIR,'apps'))

pycharm路径报错解决

1. 虽然我们添加了导包路径的设置，到时pycharm并不能直接识别，依然会颜色标注提示路径的错误，即使不影响程序的运行，但看着和用着也是不舒服的。

   • 解决办法：
     告诉pycharmapps目录为导包路径

     
     image.png

2. 设置JavaScript语言
   如果templates下的js文件内容报错，可能是pycharm语言识别错误：

• 解决办法：setting- Languges&Frameworks- JavaScript中设置ECMAScript 6,具体如下：

  image.png

好的，Django项目开始前的基本配置就准备好了。