$$config title: 프로젝트기술서 keywords: - IT - ... $$ # 사이트 기술서 ## 0. 개요 ### 소개 ``` 사업장의 대기손님 관리를 위한 사이트 ``` ``` 장고와 JS를 이용한 프론트/백 구현 카카오맵,도로주소,사업자번호 API를 이용한 데이터 처리. jquery의 get post를 이용한 데이터 통신 ajax 폴링을 이용한 대기열 관리. ``` ### 1. 개발환경 #### 1-1. 형상&배포 관리 ``` Github, Jenkins ``` #### 1-2, 기술스택 ``` - Django - HTML/JavaScript/CSS - JQuery - Mysql - Docker - Jenkins ``` #### 1-3, 개발환경 ``` - Windows 10 - CentOS 7 - Visual Studio Code - SFTP ``` ### 2. 주요기능 ``` - 카카오로그인 - 카카오맵 - 대기열관리 - 대기열알림 ``` ### 3. 홈 동작화면 ![img](https://i.ibb.co/WxLkBLh/image.jpg) ### 3-1-1. 카카오맵 소스코드 ```javascript ``` ### 3-1. 카카오로그인화면 ![img](https://i.ibb.co/mhrn9jf/image.png) #### 3-1-1, 장고 Model 코드 ```python class User(AbstractUser): class GenderChoices(models.TextChoices): MALE = "M", "남성" FEMALE = "F", "여성" class ProviderTypeCodeChoices(models.TextChoices): LOCAL = "local", "로컬" KAKAO = "kakao", "카카오" gender = models.CharField('성별', max_length=1, blank=True, choices=GenderChoices.choices) avatar = models.ImageField('아바타', blank=True, upload_to="accounts/avatar/%Y/%m/%d", help_text="100px * 100px 크기의 gif/png/jpg 이미지를 업로드해주세요.") provider_type_code = models.CharField('프로바이더 타입코드', max_length=20, choices=ProviderTypeCodeChoices.choices,default=ProviderTypeCodeChoices.LOCAL) provider_accounts_id = models.PositiveIntegerField('프로바이더 회원번호', default=0) #has_shop은 추후삭제예정. @staticmethod def login_with_kakao(request: HttpRequest, provider_accounts_id): provider_type_code = User.ProviderTypeCodeChoices.KAKAO qs: QuerySet = User.objects.filter(provider_type_code=provider_type_code, provider_accounts_id=provider_accounts_id) if not qs.exists(): username = provider_type_code + "__" + str(provider_accounts_id) name = provider_type_code + "__" + str(provider_accounts_id) email = "" password = "" user: User = User.objects.create_user(username=username, email=email, password=password, first_name=name, provider_type_code=provider_type_code, provider_accounts_id=provider_accounts_id) else: user: User = qs.first() login(request, user) def have_shop(self): if len(self.shop_set.all()) >= 1: return True else: return False def checker(self): return self.is_authenticated def where_waiting(self): """ test """ waitings = dir(User.objects.select_related()) return waitings ``` #### 3-1-2. 장고 Views 코드 ``` def Kakao_login(request : HttpRequest): REST_API_KEY = os.environ.get("WAITING_HOW__REST_API_KEY") REDIRECT_URI = os.environ.get("WAITING_HOW__LOGIN_REDIRECT_URI") next_url = request.GET.get('next') kakao_auth_api = "https://kauth.kakao.com/oauth/authorize?" return redirect( f"{kakao_auth_api}client_id={REST_API_KEY}&redirect_uri={REDIRECT_URI}&response_type=code&state={next_url}" ) def Kakao_login_callback(request): code = request.GET.get("code") REST_API_KEY = os.environ.get("WAITING_HOW__REST_API_KEY") REDIRECT_URI = os.environ.get("WAITING_HOW__LOGIN_REDIRECT_URI") token_request = requests.get( f"https://kauth.kakao.com/oauth/token?grant_type=authorization_code&client_id={REST_API_KEY}&redirect_uri={REDIRECT_URI}&code={code}" ) token_json = token_request.json() error = token_json.get("error", None) if error is not None: raise Exception('카카오 로그인 에러') access_token = token_json.get("access_token") profile_request = requests.get( "https://kapi.kakao.com/v2/user/me", headers={"Authorization": f"Bearer {access_token}"}, ) profile_json = profile_request.json() id = profile_json.get("id") User.login_with_kakao(request, id) user = User.objects.get(provider_accounts_id=id) messages.success(request, f"{user.username}님 카카오톡 계정으로 로그인되었습니다") next_url = request.GET.get('state') if next_url.lower() != "none": return redirect(next_url) return redirect("accounts:user_info") ``` ### 3-2. 대기열 추가화면 ||| |---|---| |![대기열](https://i.ibb.co/LChqSzS/image.png)|![인원수](https://i.ibb.co/BcXbWMq/image.png)| ### 3-2-1. 코드 ```python @active_required @login_required def add_waiting(request,shop_id): shop = Shop.objects.get(id=shop_id) phone_number = request.POST.get('phone_number') context= {'shop':shop,'phone_number':phone_number} # if not Shop.objects.filter(master=request.user,shop_id=shop_id): # context += {'phone_number':request.user.phone_number} # return render(request,'waitings/howmany.html',context) if request.method == 'POST': if Waiting.is_waiting(phone_number): messages.warning(request,f"이미 예약중입니다.") return render(request,'waitings/views.html',context) if len(phone_number)<10: messages.warning(request,"전화번호가 너무 짧습니다.") return render(request,'waitings/views.html',context) request.POST.adults = "0" request.POST.kids = "0" return render(request,'waitings/howmany.html',context) return render(request,'waitings/views.html',context) ``` ![완료시](https://i.ibb.co/Khg4Dgm/image.png) #### 3-2-2. 코드 ```python @active_required @login_required def add_people(request,shop_id): shop = Shop.objects.get(id=shop_id) _phone_number = request.POST.get('phone_number') adults = request.POST.get('adults') kids = request.POST.get('kids') if adults == "0" and kids == "0": context = {'phone_number':_phone_number,'shop':shop} return render(request,'waitings/howmany.html',context) how_many = int(adults)+int(kids) waiting = Waiting(phone_number=_phone_number,how_many=how_many, adults=adults,kids=kids,is_entered=False, shop_name=shop,is_disposed=False) #shop_id와 request.user가 일치하지 않으면 waiting.client=request.user if shop.master != request.user: waiting.client = request.user waiting.save() context = {'shop':shop} messages.success(request,"예약되었습니다.") return redirect('waitings:views',shop_id=shop.id) ``` ### 3-3. 업주화면 ||| |---|---| |![업주화면 반응형-1](https://i.ibb.co/bmrXHM4/image.png)|![업주화면 반응형-2](https://i.ibb.co/7SPY53z/image.png)| #### 3-3-1. 코드 ```html d ``` ### 3-4. 문자메세지 전송 #### 3-4-1. views.py ```python @owner_required def call_waiting(request): shop_id = request.GET.get('shop_id') message_id = request.GET.get('message_id') whereami = len(Waiting.objects.filter(shop_name=shop_id,id__lt=message_id,is_entered=False,is_disposed=False)) waiting = Waiting.objects.get(id=message_id) waiting.call_waiting(whereami) return redirect('shops:admin',shop_id=shop_id) ``` #### 3-4-1. models.py ```python def call_waiting(self,number): ''' phone_number에 적힌 번호를 기준으로 문자api호출 ''' context = f"{self.shop_name}의 대기열이 {number}팀 남았습니다." if "000" not in self.phone_number: send_message(self.phone_number,context) self.is_called = True self.save() ``` ### 4. API관련 #### 4-1. request와 requests모듈을 사용하여 호출 ```python def get_location(keyword,page=1,perPage=5): """ keyword,page,perPage """ print('도로명주소 검색API 서비스를 이용한 주소검색결과를 보여줍니다.') keystr = keyword #print(resulttype) url = 'http://www.juso.go.kr/addrlink/addrLinkApi.do?' queryParams = urlencode({ quote_plus('currentPage') : page , quote_plus('countPerPage') : perPage, quote_plus('resultType') : 'json', quote_plus('keyword') : keystr, quote_plus('confmKey') : '비밀' }) request = Request(url + queryParams) request.get_method = lambda: 'GET' response_body = urlopen(request).read() #print(response_body.decode('utf-8')) root_json = json.loads(response_body) return root_json['results']['juso'],root_json['results']['common']['totalCount'] def get_business_number(keyword,page=1): keyword = ''.join(char for char in keyword if char.isnumeric()) print('사업자등록번호 진위확인 결과') #print(resulttype) servicekey="비밀" datas =json.dumps({ "b_no": [keyword], }) url = "https://api.odcloud.kr/api/nts-businessman/v1/status?"+ urlencode({ quote_plus('serviceKey'):servicekey }) headers = { 'Content-Type':'application/json; charset=utf-8' } results = requests.post(url,data=datas,headers=headers).json() if results['data'][0]['b_stt_cd'] !='': status = True else: status = False return keyword,status ``` ### 5. Docker ```yaml version: "3" services: waiting_how: build: . container_name : waiting_how volumes: - .:/usr/src/app ports: - 8040:8040 ``` ```Dockerfile FROM python:3.10 LABEL Farrar142 "gksdjf1690@gmail.com" ENV PYTHONUNBUFFERED 1 WORKDIR /usr/src/app COPY . . RUN pip3 install -r requirements.txt \ && apt-get update ENTRYPOINT python manage.py makemigrations && python manage.py migrate && python manage.py runserver 0.0.0.0:8040 ``` ### 6. jenkins Build Script ```python import os,sys import locale import subprocess import time import socket from datetime import datetime from pathlib import Path def deploy(): global project_dir,docker_work_dir build_id = os.environ.get('BUILD_NUMBER') or get_now() path = get_setting_path() #초기 실행 변수 init = False #젠킨스의 빌드이름을 환경변수로 걊을 받습니다, 없으면 python__1입니다. project_name = os.environ.get("JOB_NAME") or "python__2" #윈도우에서 테스트용 설정입니다. if get_sys()=="Win": python = "python" project_dir = '.' else: python = "python3" #젠킨스 빌드가 위치하게 될 곳으로 수정해주세요 project_dir = f"/docker_projects/nginx__1/data/site_projects/{project_name}" #꼭 본인의 경로에 맞게 수정해주세요!# requirements_path = "requirements.txt" #호스트의 절대주소+빌드이름을 받습니다.(도커소켓을 연결해놔서 연동이됨) #도커컨테이너 안의 프로젝트 폴더입니다. docker_work_dir = "/usr/src/app" volume_link = f"{project_dir}:{docker_work_dir}" image_name="python2" deploy_con_name="python__2" test_con_name="python__2__test" database_con_name="mariadb__1" test_port="7999" deploy_port="8001" # execute_file="manage.py" deploy_setting_file=f"{path}.prod" cur_image_name = f"{image_name}:{build_id}" deploydockerfile = "dockerfile" deploylogfile = "deploy_log_file.txt" make_deploy_logs(deploylogfile) print("0.DB컨테이너 확인") try: db_con = Container(get_specific_container(f"{database_con_name}")) if connection_checker(db_con,1)==False: raise Exception("DB 컨테이너 연결 실패") except: raise Exception("DB 컨테이너 연결 실패") revise_dockerfile(execute_file,requirements_path,deploydockerfile) print("1.배포용 컨테이너 확인") try: prev_con = Container(get_specific_container(f"{deploy_con_name}")) except: init = True print("2.남아있는 테스트 컨테이너 삭제") try: shut_con = Container(get_specific_container(f"{test_con_name}")) shut_img_con(shut_con.container_name,shut_con.image_name) except: pass print("3.테스트용 이미지 생성") os.system("docker pull python:3.10") result = get_logs(f"docker build --force-rm -t {cur_image_name} .") fail_checker(result,test_con_name,cur_image_name,deploylogfile,"이미지 빌드 실패 requirements 혹은 test를 확인해주세요") print("4.make_Test_Con_And_Test") result = get_logs(f"docker run -d -p {test_port}:{test_port} --name {test_con_name} {cur_image_name} gunicorn --bind 0:{test_port} {path}.wsgi") fail_checker(result,test_con_name,cur_image_name,deploylogfile,"컨테이너 빌드 실패 requirements에 gunicorn이 설치 되어있는지 확인 해 주세요") print("5.테스트 컨테이너 실행 확인") con_info = get_specific_container(f"{test_con_name}") try: test_con = Container(con_info) except: shut_img_con(test_con_name,cur_image_name) raise Exception("테스트 컨테이너 실행이 실패했습니다. requirements나 setting을 확인해주세요") # print("6.컨테이너 네트워크 연결 테스트") # if connection_checker(test_con,10) == False: # shut_img_con(test_con.container_name,cur_image_name) raise Exception("테스트 컨테이너 연결 실패") else:##connection check success os.system(f"docker rm -f {test_con.container_name}") if init == False:##첫실행이 아닐시 shut_img_con(prev_con.container_name,prev_con.image_name) # print("7.배포컨테이너 생성") print(f"docker run -d -p {deploy_port}:{deploy_port} --name {deploy_con_name}" + f" -v {volume_link}"+ f" --restart unless-stopped {cur_image_name}" + f" gunicorn --bind 0:{deploy_port} {path}.wsgi") os.system(f"docker run -d -p {deploy_port}:{deploy_port} --name {deploy_con_name}" + f" -v {volume_link}"+ f" --restart unless-stopped" f" {cur_image_name}" + f" gunicorn --bind 0:{deploy_port} {path}.wsgi") print("8.마이그레션") os.system(f"docker exec {deploy_con_name} {python} {execute_file} migrate --settings={deploy_setting_file}") os.system(f'docker exec {deploy_con_name} bash -c "echo yes | {python} {execute_file} collectstatic"') #messagr success## print(" ")# print("Build Succeed") print("Container Info") get_specific_container(f"{deploy_con_name}") try: os.remove(f"{deploylogfile}") except: pass try: os.remove(f"{deploydockerfile}") except: pass class Container: def __init__(self,con): self.container_name = con[0] self.image_name = con[2] self.ip = con[-1] self.port = con[-2] def get_sys(): """ get_os_name """ global os_encoding os_encoding = locale.getpreferredencoding() if os_encoding.upper() == 'cp949'.upper(): return "Win" elif os_encoding.upper() == 'UTF-8'.upper(): return "Lin" def get_logs(cmd): """ get_logs_from_command """ os_encoding = locale.getpreferredencoding() if os_encoding.upper() == 'cp949'.upper(): # Windows return subprocess.Popen( cmd, stdout=subprocess.PIPE).stdout.read().decode('utf-8').strip() elif os_encoding.upper() == 'UTF-8'.upper(): # Mac&Linux return os.popen(cmd).read() else: print("None matched") exit() def get_ports_from_strings(_result, words): """ parse_ports_from_logs """ try: tcp = words[-2].split("->") _tcp = "" for strings in tcp: if "tcp" in strings: _tcp = strings break return _tcp.split("/")[0] except: return "" def get_docker_containers(): """ parse_containers_informations """ cmd = "docker ps -a" logs = get_logs(cmd).split("\n") column = logs.pop(0) result = [] if logs: for line in logs: words = line.split(" ") while '' in words: words.remove('') for i in range(len(words)): words[i] = words[i].strip().strip() try: status = words[4].strip().split(" ")[0] # print(f"C Name :: {words[-1]}, C ID :: {words[0]}, Img Name :: {words[1]} , Status :: {status}") _result = [words[-1], words[0], words[1], status] # get ports _result.append(get_ports_from_strings(_result, words)) # get ip _result.append(get_logs( "docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "+words[0]).strip("'").strip("\n")) except: pass result.append(_result) else: print("No Containers") return result def get_specific_container(cmd): """ get_specific_container """ a = get_docker_containers() for i in a: if i[0] == cmd: print(f"컨테이너이름 : {i[0]}") print(f"이미지이름 : {i[2]}") print(f"내부ip주소 : {i[5]}") print(f"포트주소 : {i[4]}") print(f"현재상태 : {i[3]}") return i return [] def get_now(): """ make a string by current time """ now=datetime.now() nows = [now.year,now.month,now.day,now.hour,now.minute,now.second] nowtime = "" for i in nows: nowtime = nowtime + str(i).zfill(2) return nowtime def connection_checker(test_con,counter): """ check container's network put container instance """ osType = get_sys() print(f"현재 os 타입 :{osType}") if osType == "Lin": myip = '172.17.0.1' else: myip = socket.gethostbyname(socket.gethostname()) print(f"네트워크 연결 준비") print(f"로컬IP주소 :{myip}") print(f"포트주소 :{test_con.port}") server_address = (myip,int(test_con.port)) fail_counter = 0 for i in range(counter): time.sleep(1) try: sock = socket.socket(socket.AF_INET,socket.SOCK_STREAM) sock.settimeout(1) sock.connect(server_address) sock.close() print(f"{i+1} {test_con.container_name} Connection Succeed") except: print(f"{i+1} {test_con.container_name} Connection Failed") fail_counter += 1 sock.close() if fail_counter: return False else: return True def get_setting_path(): """ find the setting.py's directory """ setting_path = "" for path, dirs, files in os.walk(os.getcwd()): for i in files: if i == 'wsgi.py': setting_path = path break osType = get_sys() if osType == "Win": return setting_path.split("\\")[-1] else: return setting_path.split("/")[-1] def revise_dockerfile(execute_file,requirements_path,deploydockerfile): """ dockerfile의 test 를 실행 할 때 사용할 설정 파일을 수정해줍니다. Args: execute_file ([파일이름]]) """ global project_dir,docker_work_dir context = f"FROM python:3.10\nENV PYTHONUNBUFFERED 1\nWORKDIR {docker_work_dir}\nCOPY . .\n#deploy.py에서 requirements_path를 수정해주세요\n#다른 폴더에 있다면 폴더이름/텍스트파일.txt 의 형식입니다.\nRUN pip3 install -r {requirements_path}\nRUN pip3 install django\nRUN python3 {execute_file} test" f = open(f"{deploydockerfile}",'w',encoding='UTF-8') f.write(context) f.close() def shut_img_con(con,img): os.system(f"docker rm -f {con}") os.system(f"docker rmi -f {img}") #os.system(f"docker image prune -f")# def fail_checker(cmd,con,img,deploylogfile,message):# lines = cmd.split("\n") for i in lines: line = i.lower() f = open(f"{deploylogfile}","a") f.write(line) f.write('\n') if "error" in line: shut_img_con(con,img) f.close() raise Exception(message) f.close() return True def make_deploy_logs(deploylogfile): f = open(f"{deploylogfile}","w") f.write("") f.close() def env_getter(): path = Path(__file__).resolve().parent print(path) f = open(f"{str(path.parent)}/.env","r",encoding="UTF-8") target = open(f"{str(path)}/.env","w",encoding="UTF-8") target.write(f.read()) target.close() f.close() def main(): try: env_getter() except: raise Exception(".env파일을 프로젝트 경로 위에 만들어 주세요") deploy() if __name__ == "__main__": main()# ```