路飞项目前后端搭建、包导入、后端目录调整

一、路飞项目前后端搭建

创建后端项目的时候可以参考上一篇博客的步骤,下面是一些注意事项

  • 创建路飞项目前,虚拟环境中先装好 django 3.2.2
  • 选中虚拟环境,起名叫luffy_api

创建前端的vue项目

  • 进入到需要创建项目的目录下,执行命令创建项目(这里我创在后端项目的同一个文件夹内)

    vue create luffy_city
    

    其余配置跟之前的流程一样这里只做简单的解释

    可以参照此篇博客:https://www.cnblogs.com/LZXSDM/p/17138820.html

    输入命令后进入配置选择(vue2、babel、router、vuex)

    ppCe1eK.png

    等待一段时间就会安装成功

二、包导入

模块和包的区别

  • 模块就是一个py文件
  • 包是一个文件夹下有__init__.py,里面有很多py文件

以后下载第三方包,或自己写包,如何导入?

- pycharm会把项目路径加入到环境变量 ,命令行中不会加入
- from 的路径,需要从环境变量开始
    -安装的第三方模块,都在环境变量
    -内置模块 os,sys, 也在环境变量中,可以直接导入
- 在包内部,推荐使用相对导入
    -一旦使用相对导入,该文件,就不能以脚本形式运行了(不能右键运行)
    -在同一个目录下的推荐使用相对导入
    -不同目录下的推荐使用绝对导入

三、后端目录调整

"""
├── luffy_api
	├── logs/				# 项目运行时/开发时日志目录 - 包
    ├── manage.py			# 脚本文件
    ├── luffy_api/      		# 项目主应用,开发时的代码保存 - 包
     	├── apps/      		# 开发者的代码保存目录,以模块[子应用]为目录保存 - 包
        ├── libs/      		# 第三方类库的保存目录[第三方组件、模块] - 包
    	├── settings/  		# 配置目录 - 包
			├── dev.py   	# 项目开发时的本地配置
			└── prod.py  	# 项目上线时的运行配置
		├── urls.py    		# 总路由
		└── utils/     		# 多个模块[子应用]的公共函数类库[自己开发的组件]
    └── scripts/       		# 保存项目运行时的脚本文件,小的测试脚本 - 文件夹,不提交到git上
"""

ps1:创建项目后会有一个settings.py的文件,我们把他放到settings包中,重命名成dev.py

ps2:当我们调整了目录结构之后项目是运行不了的,内部的很多文件因为路径问题找不到对应的文件了,需要手动设置环境变量

步骤

步骤一:修改manage.py中的配置文件settings/dev.py的路径(因为settings.py被我们改为了dev.py)

#!/usr/bin/env python
import os
import sys


def main():
    """这里要更改配置文件的路径""" 			                 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'luffy_api.settings.dev')
    try:
        from django.core.management import execute_from_command_line
    except ImportError as exc:
        raise ImportError(
        ) from exc
    execute_from_command_line(sys.argv)


if __name__ == '__main__':
    main()

更改之后我们就可以启动项目了,如果pycharm还是不能运行,处理方法如下:h

点击运行按钮边上的下拉框,选择第一个edit选项

img

然后修改使用的配置文件

img

  • 上线阶段,对于django的web服务网关接口我们需要使用uwsgi,因为django自带的wsgiref能承受的并发量很小
  • 而使用uwsgi运行项目,启动文件和配置文件都不同与编写时使用的文件。我们在上线时使用wsgi.py充当启动文件,以settings文件夹下的prod.py充当配置文件
  • 因此我们还需要更改wsgi.py和asgi.py中的配置文件路径

wsgi.py

import os

from django.core.wsgi import get_wsgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'luffy_api.settings.dev')

application = get_wsgi_application()

asgi.py

import os

from django.core.asgi import get_asgi_application

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'luffy_api.settings.dev')

application = get_asgi_application()

修改了这一步,项目就基本能够正常运行了,但是后续创建文件后还是会出现不能运行的情况,这是因为环境变量的问题

创建app

方式一

  • 在项目的外层路径创建app,然后拖到对应的文件夹或包中去

命令如下:

python manage.py startapp home

img

方式二

  • 进入apps包下创建app,因为我们想把app创到apps包中
  • 我们在哪执行命令,项目就会创建在哪,因此我们需要进入到apps包中创建app

命令如下:

python ../../manage.py startapp user

img

ps:在python3中使用第二种方式创建app,需要在app包内的apps.py中修改name的值,才能成功注册并运行

user/apps.py

from django.apps import AppConfig


class UserConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'luffy_api.apps.user'

注册app

  • 根据流程,创建app之后,需要去配置文件中注册app
  • 这个时候我们注册app,需要从最外面的项目路径开始写,才能够注册成功

dev.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'luffy_api.apps.home',
    'luffy_api.apps.user',
]

配置apps包的路径,添加到环境变量中

  • 这个时候虽然成功注册了,但是写的代码太多了,我们以后想直接写app名字,所以要吧apps的路径加入到环境变量,而添加环境变量需要在配置文件的开头添加

往dev.py中配置环境变量的添加

from pathlib import Path
import sys
import os

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

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

添加了环境变量配置后,dev.py配置文件中的app注册信息就可以直接写app名称,但是在app内部的apps中我们也要把name属性改成app名称

dev.py

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

两个app的apps.py内容

userapp的apps.py

from django.apps import AppConfig

class UserConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'user'
    
    
homeapp的apps.py
from django.apps import AppConfig

class HomeConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'home'

把BASE_DIR(luffy_api)也加入到环境变量

  • 而把luffy_api文件夹添加到环境变量中也是方便了后续的编写,因为我们后面所有的操作都是在luffy_api文件夹中进行的

dev.py

from pathlib import Path
import sys
import os

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = Path(__file__).resolve().parent.parent

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

sys.path.insert(0,BASE_DIR)

这样配置以后,今后如果我们需要导入模块,就可以从项目根路径、luffy_api、apps三个位置直接导入

在解释器中设置文件夹为根路径

这个时候虽然项目可以运行,但是我们会发现解释器会出现报错,而我们把这些添加了环境变量的文件夹设置成根路径就可以停止解释器的报错

ps:解释器的根路径和项目中配置的环境变量是两个毫不相关的配置,给解释器设置根路径只是为了让解释器不对我们的代码报错(因为陪了环境变量)

posted @ 2023-02-27 20:27  dear丹  阅读(70)  评论(0)    收藏  举报