django-2-项目配置

一、项目创建和配置

1.1 准备项目代码仓库(码云)

1686382697618-c775fad9-b6c8-4c6b-bd98-9d13d3ffd555.png

1.1.1 用pycharm创建一个django项目

1690338794461-54a12748-1c3e-4073-8f21-c658acaeeef1.png

1.2 requirements.txt 文件

创建一个requirements.txt文件,将该项目所依赖的所有插件都写在这个文件中,这样就新安装项目就不需要一个一个单独安装了

1.3 将本项目所在目录设置成一个git仓库

git init

1.4 将本地仓库和远程仓库联系在一起

如何生成gitee公钥?生成/添加SSH公钥 | Gitee 产品文档

git remote add gitee git@gitee.com:wang838054392/ck14_backend.git
# gitee:给仓库取一个名称
# git@gitee.com:wang838054392/ck14_backend.git:在gitee上克隆下载时用得ssh,不过先要在pycharm中配置公钥
# 命令git remote add <shortname> <url>:将远程仓库唯一的URL<url> 映射成为 在本地仓库中对远程仓库起的别名<shortname>。(注意:git remote add <shortname> <url>只负责映射!它不会产生下载或上传的流量!只有git clone,git fetch,git pull等才产生下载或上传的流量!)

1.5 拉取文件

git pull gitee master
# gitee:在1.4步骤时,我们给取得名字
# master:要拉取的分支

1.6 提交

.gitignore:

可以将不需要提交的文件,写在.gitignore文件中,比如.idea文件

# Build and Release Folders
bin-debug/
bin-release/
[Oo]bj/
[Bb]in/

# Other files and folders
.settings/

# Executables
*.swf
*.air
*.ipa
*.apk

# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
# should NOT be excluded as they contain compiler settings and other important
# information for Eclipse / Flash Builder.

# pycharm
.idea
git add .
# 将当前目录的文件,添加到暂存区

git commit -m 'init'
# 将暂存区的文件提交到gitee仓库中
# init:提交时的备注信息

二、配置环境

项目环境分为开发环境生产环境

  • 开发环境:用于编写和调试项目代码
  • 生产环境:用于项目线上部署运行

2.1 创建一个settings的python包

分别创建base.pydev.pypro.py

settings
 |------__init__.py
 |------base.py
 |------dev.py
 |------pro.py

其中,base.py文件为原settings.py文件四个文件的代码分别如下:

"""
    原理:
        当导入settings包,会进行初始化,执行__init__.py文件的代码,
        只要配置好生产环境与开发环境的配置变量即可
    1、获取一下环境变量,
    2、如果是production,则为生产环境
    3、其他的则为dev环境
"""
import os

ENV = os.environ.get('ENV')

if ENV == 'production':
    from pro import *
else:
    from dev import *
  1. 创建配置base.py文件,其中放置基础配置项(生产,开发配置相同的部分)
"""
Django settings for ck14_backend project.

Generated by 'django-admin startproject' using Django 4.2.2.

For more information on this file, see
https://docs.djangoproject.com/en/4.2/topics/settings/

For the full list of settings and their values, see
https://docs.djangoproject.com/en/4.2/ref/settings/
"""

from pathlib import Path

# Build paths inside the project like this: BASE_DIR / 'subdir'.
# BASE_DIR = Path(__file__).resolve().parent.parent
# 因为之前这个settings.py文件是在根目录,现在多嵌套了一层,所以需要多加一个.parent
BASE_DIR = Path(__file__).resolve().parent.parent.parent


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = 'django-insecure-28371dhn&gqf2r4ru3h7&4dri&0su3k8ar)kq6s-b#d8e2-0_r'




# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
]

ROOT_URLCONF = 'ck14_backend.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [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',
            ],
        },
    },
]

WSGI_APPLICATION = 'ck14_backend.wsgi.application'





# Password validation
# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator',
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator',
    },
]


# Internationalization
# https://docs.djangoproject.com/en/4.2/topics/i18n/

LANGUAGE_CODE = 'zh-hans'

TIME_ZONE = 'Asia/shanghai'

USE_I18N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/4.2/howto/static-files/

STATIC_URL = 'static/'

# Default primary key field type
# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field

DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'

创建开发环境配置文件dev.py,其中放置开发配置项,并且在文件开头要引入base.py中的公共配置项

from base import *

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Database
# https://docs.djangoproject.com/en/4.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

创建生产环境配置文件pro.py,其中放置生产环境配置项,并且在文件开头要引入base_settings.py中的公共配置项

from base import *



# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = False

# 允许访问的域名
ALLOWED_HOSTS = ["*"]

# Database
# https://docs.djangoproject.com/en/4.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': BASE_DIR / 'db.sqlite3',
    }
}

2.2.1 pycharm的配置

1688793078282-866b07b6-ed86-4e98-8e12-de4d0a3c93ca.png

1688793173278-25f0568d-d606-45f9-87f7-ed1a279a6400.png

2.2.2 pycharm配置环境变量

1690279442230-3689e33b-e86f-4876-8126-4eccd3176609.png

1690279521541-4dba6ab9-6625-4410-b6c1-6448ef32bcd6.png

三、配置数据库

先安装数据库驱动,然后配置数据库

from .base import *

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []

# Database
# https://docs.djangoproject.com/en/4.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'ck14_backend',
        'USER': 'root',
        'PASSWORD': '123456',
        'PORT': '9999',
        'HOST': '192.168.133.10'
    }
}

四、配置工程日志

django使用python原生的logging日志模块。

4.1 配置工程日志

base.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': BASE_DIR / 'logs/lemontest.log',  # 日志文件的位置
            'maxBytes': 300 * 1024 * 1024,
            'backupCount': 10,
            'formatter': 'verbose'
        },
    },
    'loggers': {  # 日志器
        'django': {  # 定义了一个名为django的日志器
            'handlers': ['console', 'file'],  # 可以同时向终端与文件中输出日志
            'propagate': True,  # 是否继续传递日志信息
            'level': 'INFO',  # 日志器接收的最低日志级别
        },
    }
}

注意:在配置日志的时候,有个日志文件输出的目录,所以,需要在项目根目录中添加一个logs文件夹

1686450882699-7aaec437-af28-49e6-a371-9c4f083a39a6.png

日志器的使用:

例子:

import logging

# 获取日志记录器
logger = logging.getLogger('django')
# 输出日志
logger.debug('测试logging模块debug')
logger.info('测试logging模块info')
logger.error('测试logging模块error')

git管理工程日志:

提示1:

  • 开发过程中,产生的日志信息不需要代码仓库进行管理和记录。

提示2:

  • 建立代码仓库时,生成的忽略文件(.gitignore)中已经默认忽略掉了 *.log 。

问题:

  • logs文件目录需要被Git仓库记录和管理。
  • 当把 *.log 都忽略掉后,logs文件目录为空。
  • 但是,Git是不允许提交一个空的目录到版本库上的。

解决:

  • 在空文件目录中建立一个 .gitkeep 文件,然后即可提交。

五、优化子应用导入路径

5.1 创建用户模块子应用

一个项目往往会包含多个子应用,直接放在项目根目录不便于管理,所以,创建apps包,用于管理所有应用

在apps下创建users应用

cd到apps下运行如下命令创建users应用:

django-admin startapp users

5.2 注册子应用

修改应用配置

自动生成的应用配置中的name属性就是应用的名字,这在直接创建应用到项目根目录中时是不错的,但是现在我们在应用的外面嵌套了一层,需要修改name的属性为导入应用的python格式的完整路径,所以修改`users.apps.UsersConfig类的name属性如下:

from django.apps import AppConfig

class UsersConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'apps.users'  # users应用的导入的点分隔路径

注册

在INSTALLED_APPS中添加users应用的配置类的导入点分隔路径

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'apps.users.apps.UsersConfig'  # 用户子应用
]

5.3 优化子应用导入路径

添加应用根目录到环境变量path

pycharm导包的时候,查找顺序??

import sys
"""
当导入sys模块时,也就是执行 import sys 代码时,python会从
sys.path 中查找sys模块,如果有,则导入,否则报错
"""

python导入模块时,解释器首先在内置模块中查找。如果没找到,解释器再从 sys.path 变量中的目录列表里查找。所以,我们可以将项目下的apps目录插入到sys.path中,这样既可简化我们创建新应用时的操作,也可以优化导入效率。在配置文件base.py中添加如下代码:

import sys  # 导入sys
from pathlib import Path

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent.parent
sys.path.insert(0, str(BASE_DIR/'apps'))  # 将apps插入到sys.path的最前面

注册

注册方式同上,这样可以不用修改应用的配置类的name属性了。

5.4 设置pycharm

步骤5.3是告诉python代码,已经将项目放到sys.path中了,但是pycharm还不知道,所以接下啦要告诉pycharm,该代码已经是项目根目录上了

pycharm的设置

1686454356900-0055ab8a-413a-45bc-8d04-168662910001.png

1686454784536-8f619104-2478-4b82-bbae-952b7d2dddcf.png

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值