[TIL]KDT_20230427

📚 KDT WEEK 4 DAY 4 TIL

• User 추가 및 관리
• postman

 

---

 

 🟥 User

저번 학습에서 admin을 생성할 때, createsuperuser 라는 명렁어를 통해 shell에서 admin을 만들 수가 있었다.

이 admin은 하나의 User Model에 해당하는데, 이는 django.contrib.auth.models에 미리 정의되어 있는 모델이다.

 

이미 모델이 있으므로, 이를 Question 모델에 외래키로 넣어보았다.

owner = models.ForeignKey('auth.User', related_name='questions', on_delete=models.CASCADE, null=True)

User모델이 auth에 존재하므로 auth.User 형태로 작성해야 한다.

 

여기서 related_name='questions' 의 기능은..

 

저번에 shell에서 하나의 question 오브젝트에 해당하는 choice들을 가져오려면.. 명령어는

question.choice_set.all()

을 사용해야 했다.

 

하지만 related_name을 저렇게 이름으로 정의해주면,

user.questions.all()

으로도 같은 동작을 하므로, _set 부분을 생략할 수가 있다!

 

이렇게 question 모델을 수정하였으므로 migration을 잊지말자!

 

---

 

User Page

 

DRF로 QuestionList와 QuestionDetail 페이지를 구현했던 것처럼, User Page도 작성해보자.

 

방법과 순서는 동일하다. Serializer 작성 ▶ views.py 작성 ▶ urls.py 작성

 

UserSerializer

▶ polls_api/serializers.py

from django.contrib.auth.models import User

class UserSerializer(serializers.ModelSerializer):
    questions = serializers.PrimaryKeyRelatedField(many=True, queryset=Question.objects.all())
    
    class Meta:
        model = User
        fields = ['id', 'username', 'questions']

QuestionSerializer와 다르게 필요한 부분이 한 줄 더 있다.

UserSerializer에서는 'questions' 필드를 가져오기 위해 questions를 위에서 정의해줄 필요가 있다!

 

user.questions.all() 이나question.choice_set.all() 의 query문을 살펴보면,

항상 WHERE문에서 외래키를 사용한 모델에서 외래키를 사용받은 모델로 id를 찾아가도록 되어있다.

ex) user.questions.all()의 경우, WHERE "polls_question"."owner_id" = 1

따라서  'questions' 필드를 가져오기 위해서는 questions를 먼저 정의해주어야 한다!

 

UserList, UserDetail Page View

▶ polls_api/views.py

from django.contrib.auth.models import User
from polls_api.serializers import UserSerializer

class UserList(generics.ListAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    
class UserDetail(generics.RetrieveAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer

generics에서 필요한 기능을 선택하고 상속받아준다. 단순 출력이라면 해당 APIView만으로도 충분하다.

 

▶ polls_api/urls.py

urlpatterns = [
    path('users/', UserList.as_view(),name='user-list'),
    path('users/<int:pk>/', UserDetail.as_view()),
]

urls.py에 해당 path을 설정해주면 끝이다.

id가 아닌 pk를 사용한다는 걸 잊지말자.

 

UserList Page

 

UserDetail Page

 

---

 

User 생성하기

 

미리 만들어져 있는 UserCreationForm과 Serializer을 사용하는 방법을 각각 소개하겠다.

 

 

1. Form을 이용하는 방법

▶ polls/views.py

from django.views import generic
from django.urls import reverse_lazy
from django.contrib.auth.forms import UserCreationForm

class SignupView(generic.CreateView):
    form_class = UserCreationForm
    success_url = reverse_lazy('user-list') # Redirection
    template_name = 'registration/signup.html'

SignupView라는 페이지를 만들기 위해 views.py에 함수를 하나 만들어주었다.

generic에서 지원하는 유저 생성 Form을 가져다 쓸 것이므로, 생성에 필요한 변수들을 선언하여 사용한다.

• UserCreationForm : 장고에서 지원하는 기본 회원가입 폼
• reverse_lazy : url의 name을 통해 Redirection할 때 사용함. 동작 완료 후 해당 name의 url로 이동

위 템플릿으로 가져오겠다고 선언한 signup.html을 작성해보자.

 

▶ templates/registration/signup.html

<h2>회원가입</h2>
<form method="post">
    {% csrf_token %}
    {{ form.as_p }} <!-- User Creation Form 자동 -->
    <button type="submit">가입하기</button>
</form>

{{form.as_p}} 는 form에 정의한 모델 필드에 해당하는 html 코드를 자동으로 생성한다.

 

▶ polls/urls.py

urlpatterns = [
    path('signup/', SignupView.as_view(), )
]

해당 path를 추가하여 회원가입 페이지의 url을 생성한다.

 

해당 url로 이동하면 자동완성된 회원가입 페이지를 확인할 수 있다.

이 페이지에서는 패스워드의 제한 사항 등의 기능도 자동으로 지원한다.

 

 

2. Serializer를 이용하는 방법

 

▶ polls_api/serializers.py

# JSON을 통한 API 구현을 하고있기 때문에, 사용자 등록도 Serializer를 사용하는게 좋다
# UserSerializer를 사용하지 않은 이유는 아래 함수들을 모두 구현해야 하기 때문이다.
class RegisterSerializer(serializers.ModelSerializer):
    password = serializers.CharField(write_only = True, required = True, validators = [validate_password]) # 패스워드 검증
    password2 = serializers.CharField(write_only = True, required = True) # 패스워드가 같은지

    def validate(self, attrs):
        if attrs['password'] != attrs['password2']:
            raise serializers.ValidationError({"password" : "두 패스워드가 일치하지 않습니다."})
        return attrs
    
    def create(self, validated_data):
        user = User.objects.create(username = validated_data['username'])
        user.set_password(validated_data['password'])
        user.save()

        return user

    class Meta:
        model = User
        fields = ['username', 'password','password2']

• 몇 가지 함수를 직접 구현해야 하기 때문에 이미 구현된 UserSerializer를 사용하지 않고 새로 만들었다.
• password의 2차 검증을 위해 password2까지 정의하고, validate 함수를 통해 일치검증을 동작한다.
• password2의 존재로, 기존 ModelSerializer의 create가 제대로 동작하지 않으므로 create함수를 오버라이딩해준다.

▶ polls_api/views.py

from polls_api.serializers import RegisterSerializer

class RegisterUser(generics.CreateAPIView):
    serializer_class = RegisterSerializer

views.py에 구현한 RegisterSerializer를 사용하여 view를 정의하고,

urls.py에 추가한다.

path('register/', RegisterUser.as_view()),

 

해당 url로 접속했을 때, 구현된 페이지의 모습

 

User Login, Logout

추가로 로그인, 로그아웃 기능까지 구현하려면.. 이것도 DRF에서 지원하는 기능이 있어 간편하게 구현이 가능하다.

먼저 urls.py에 하나의 path를 추가한다.

path('api-auth/', include('rest_framework.urls'))

rest_framework.urls을 찾아가서 들여가보면, 어떻게 로그인과 로그아웃이 구현되는지도 알 수 있다!

 

그리고 mysite/settings.py에

LOGIN_REDIRECT_URL = reverse_lazy('question-list')
LOGOUT_REDIRECT_URL = reverse_lazy('question-list')

해당 이름의 변수로 리다이렉션을 구현해주면, 로그인과 로그아웃 이후 해당 페이지로 이동한다.

 

구현된 로그인 페이지 화면. URL이 조금 생각했던 것과는 달랐다.

 

---

 

생성한 Question의 Owner 할당하기

 

question-list 페이지 하단부에 있는 question 생성부

 

로그인이 된 상태에서 위의 생성부를 통해 Question 객체를 생성하면, Owner를 할당해주도록 만들어본다.

 

 

▶ polls_api/serializers.py

class QuestionSerializer(serializers.ModelSerializer):
    owner = serializers.ReadOnlyField(source='owner.username')

    class Meta:
        model = Question
        fields = ['id', 'question_text', 'pub_date','owner'] # ModelSerializer를 통해 자동으로 생성

ModelSerializer 덕분에 owner를 추가하는 것은 쉽다.

fields에 owner 속성을 추가해주고, owner는 생성할 때 선택하거나 입력되는게 아니므로 Readonly옵션도 붙여준다.

 

▶ polls_api/views.py

class QuestionList(generics.ListCreateAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer
    permission_classes = [permissions.IsAuthenticatedOrReadOnly] # 로그인되어있지 않으면 readonly

    def perform_create(self, serializer):
        serializer.save(owner=self.request.user) # 이미 로그인된 사용자를 지정함, owner가 readonly여도 .save() 동작에든 무엇이든 다 됨

 

perform_create함수를 오버라이딩해서, 현재 로그인된 user가 owner가 되도록 구현해준다.

중요한 점은, .save()는 readonly 옵션을 무시하고 들어온 값을 할당해준 다는 것이다. id도 가능하다!

또한 로그아웃 상태일 때, 즉 user 정보가 없을 때는 입력받지 않아야 하므로 permission_classes를 위처럼 정의해준다.

 

추가로 user는 자기가 만든 question만 수정이 가능해야 할 것이다.

따라서 permissions.py를 만들어 정의해준다.

 

▶ polls_api/permissions.py

from rest_framework import permissions

class IsOwnerOrReadOnly(permissions.BasePermission):
    def has_object_permission(self, request, view, obj):
        if request.method in permissions.SAFE_METHODS: # SAFE_METHODS = ('GET', 'HEAD', 'OPTIONS') read_only는 항상 허용
            return True
        
        return obj.owner == request.user # 오브젝트의 소유자가 요청한 사용자 인가? 맞으면 True

이렇게 따로 permission.py를 만들어서 내가 필요했던 기능을 함수로 구현해두고..

 

 

▶ polls_api/views.py

class QuestionDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Question.objects.all()
    serializer_class = QuestionSerializer
    permission_classes = [permissions.IsAuthenticatedOrReadOnly, IsOwnerOrReadOnly]

permission을 사용하는 views.py의 해당 페이지 permission_classes에 위처럼 구현한 함수를 추가해주면 된다!

 

 

---

 

🟦 간단히 postman 사용하기

위에서 구현한 permission처럼 제한적인 상황에서만 CRUD등의 기능이 가능하도록 만들었다면,

다른 상황에서 CRUD를 요청했을 때 어떤 응답이 나오는지 장고 사이트만으로는 알기가 힘들다.

 

이런 다양한 상황을 확인하기 위해 사이트에 특정 요청을 보내고 응답을 받아볼 수 있는 Postman 플랫폼을 사용해본다.

 

직접 형태를 만들어주었으므로 raw 옵션을 사용했다.

 

PUT을 사용해 question_id = 12 해당하는 객체에 update 요청을 보내보면..

 

403 Forbidden 에러를 받아볼 수 있다!

역시 로그인이 되어있지 않아 오류가 나타난다.

 

그러면 Postman에서 로그인 정보를 넘기려면 어떻게 해야할까?

 

사이트의 개발자도구>Application탭>Cookies를 확인해보면 필요한 name과 value를 알 수 있다.

sessionid가 로그인정보, csrftoken도 나온다.

이걸 Postman에 넣어 재시도해보자.

 

csrftoken은 위처럼 두번 사용하게 된다.