1. 创建Django REST framework工程
1.1手动创建工程文件夹
1.2进去工程文件夹内,执行命令:django-admin startproject web_project创建工程目录
1.3修改,添加目录结构
apps 存放Django的应用
libs 存放第三方的库文件
settings 存放配置文件的目录,分为开发dev和线上prod
utils 存放项目自己定义的公共函数或类等
docs 用于存放一些说明文档资料
2.修改配置文件
2.1 将Django工程中的settings.py文件拷贝到新创建的settings目录下,并重命名为dev.py,并修改入口文件manage.py文件中配置文件路径。
2.2修改settings/dev.py 文件中的路径信息
我们将Django的应用放到了 工程目录/web_project/apps目录下,如果创建一个应用,比如users,那么在配置文件的INSTALLED_APPS中注册应用应该如下:
INSTALLED_APPS =[
...'web_project.apps.users.apps.UsersConfig',
]
为了还能像如下方式简便的注册引用,我们需要向Python解释器的导包路径中添加apps应用目录的路径。
INSTALLED_APPS =[
...'users.apps.UsersConfig',
]
我们将配置文件改为放在settings子目录下,所以 配置文件中的BASE_DIR指向的变为了工程目录/web_project/web_project/web_project.
使用sys.path添加/apps目录,即可添加apps应用的导包路径。
#Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))#添加导包路径
importsys
sys.path.insert(0, os.path.join(BASE_DIR,'apps'))
2.3 INSTALLED_APPS
pip install djangorestframework
在INSTALLED_APPS中添加rest_framework
INSTALLED_APPS =[
...'rest_framework',
]
2.4数据库配置
采用mysql数据库
DATABASES ={'default': {'ENGINE': 'django.db.backends.mysql','HOST': '127.0.0.1', #数据库主机
'PORT': 3306, #数据库端口
'USER': 'caicai', #数据库用户名
'PASSWORD': 'caicai', #数据库用户密码
'NAME': 'web_project' #数据库名字
}
}
注意:
记得在/web_project/web_project/__init__.py文件中添加
importpymysql
pymysql.install_as_MySQLdb()
进入mysql数据库,为项目创建数据库
create database web_project default charset=utf8;
为本项目创建数据库用户(不再使用root账户)
create user caicai identified by 'caicai'; 创建用户账号 meiduo, 密码 meiduo (由identified by 指明)
grant all on web_project.* to 'caicai'@'%'; 授权web_project数据库下的所有表(web_project.*)的所有权限(all)给用户caicai在以任何ip访问数据库的时候('caicai'@'%')
flush privileges; 刷新生效用户权限
2.5安装django-redis,并配置
执行命令进行安装:pip install django-redis
CACHES ={"default": {"BACKEND": "django_redis.cache.RedisCache","LOCATION": "redis://10.211.55.5:6379/0","OPTIONS": {"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
},"session": {"BACKEND": "django_redis.cache.RedisCache","LOCATION": "redis://10.211.55.5:6379/1","OPTIONS": {"CLIENT_CLASS": "django_redis.client.DefaultClient",
}
}
}
SESSION_ENGINE= "django.contrib.sessions.backends.cache"SESSION_CACHE_ALIAS= "session"
除了名为default的redis配置外,还补充了名为session的redis配置,分别使用两个不同的redis库。
同时修改了Django的Session机制使用redis保存,且使用名为'session'的redis配置。
此处修改Django的Session机制存储主要是为了给Admin站点使用。
2.6本地化语言和时区
LANGUAGE_CODE = 'zh-hans'TIME_ZONE= 'Asia/Shanghai'
2.7日志
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.utils.log.RequireDebugTrue',
},
},'handlers': {'console': {'level': 'DEBUG','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/web_project.log"), #日志文件的位置
'maxBytes': 300 * 1024 * 1024,'backupCount': 10,'formatter': 'verbose'},
},'loggers': {'django': { #定义了一个名为django的日志器
'handlers': ['console', 'file'],'propagate': True,
},
}
}
2.8异常处理
修改Django REST framework的默认异常处理方法,补充处理数据库异常和Redis异常。
新建utils/exceptions.py
from rest_framework.views importexception_handler as drf_exception_handlerimportloggingfrom django.db importDatabaseErrorfrom redis.exceptions importRedisErrorfrom rest_framework.response importResponsefrom rest_framework importstatus#获取在配置文件中定义的logger,用来记录日志
logger = logging.getLogger('django')defexception_handler(exc, context):"""自定义异常处理
:param exc: 异常
:param context: 抛出异常的上下文
:return: Response响应对象"""
#调用drf框架原生的异常处理方法
response =drf_exception_handler(exc, context)if response isNone:
view= context['view']if isinstance(exc, DatabaseError) orisinstance(exc, RedisError):#数据库异常
logger.error('[%s] %s' %(view, exc))
response= Response({'message': '服务器内部错误'}, status=status.HTTP_507_INSUFFICIENT_STORAGE)return response
配置文件中添加
REST_FRAMEWORK ={#异常处理
'EXCEPTION_HANDLER': 'web_project.utils.exceptions.exception_handler',
}
3.实现第一个app应用
-----待补充