🧑🏻‍💻시니어개발자🧑🏻‍💻

본내용은 필자의 " React&Python으로 웹개발(링크서비스)" 카테고리 개발소스에 계속 추가하는 방식으로 진행합니다.

( 소스 폴더는 위 카테고리를 잘 읽어보고,  git 소스를 참고하시기 바랍니다. )

react-keycloak 라이브러리의 useKeycloak Hook를 사용하여 로그인 페이지 호출

이전글에서 Keycloak 로그인 페이지를 호출하여 로그인을 하도록 처리했었다.

이번에는 Keycloak 로그인 페이지를 통해 로그인후 token 정보를 가져와 Keycloak의 저장된 사용자 정보를 확인 해보자. 

사용자 정보를 가져오기 위해서 신규 소스를 추가한다.

신규 1개와 기존 소스를 수정하고 react에 신규 패키지를 설치할 예정이다.

1. userinfo.jsx (신규)

2. menu.jsx (수정)

3. 신규 패키지 설치 :  yarn add base-64

먼저 JWT 에 대해서 간단히 설명하자.
로그인시 토큰 관련된 인증을  대부분 사용한다.
그 중에서도 JWT는 웹 표준을 따르고 있으며, JSON 객체를 사용하여 정보를 전달합니다.
JWT의 장점 중 하나로, 웹 표준을 따르기 때문에 대부분의 언어가 이를 지원합니다.

JWT는 각각의 구성요소가 점(.) 으로 구분이 되어 있으며 , 구성요소는 HEADER(헤더).PAYLOAD(내용).SIGNATURE(서명) 형태로 구성되어 있다.  

JWT 디코딩 확인 사이트 : jwt.io

아래 소스에서는 추가적으로 PAYLOAD 디코딩까지 포함한다.

⌘ userinfo.jsx ( 위치: linkservice/client/src/component/userinfo.jsx )

---------------------------------------------------------------------------------------------------

아래 소스를 반영한다.

import { useKeycloak } from "@react-keycloak/web";
import base64 from "base-64";
import React from "react";

const UserInfo = () => {

    const { keycloak } = useKeycloak();
    let payload, decodingInfo;
    
    const accessToken = keycloak.idToken;

    if (accessToken) {
      payload = accessToken.split('.')[1];
      decodingInfo = base64.decode(payload);
    }

  return (
    <div className="container">
      <div >

        <p>idToken 정보</p>
        <textarea cols="100" rows="8" value={keycloak.idToken} readOnly>
        </textarea>

        <p>token 정보</p>
        <textarea cols="100" rows="8" value={keycloak.token} readOnly>
        </textarea>

        <p>payload 정보</p>
        <textarea cols="100" rows="8" value={decodingInfo} readOnly>
        </textarea>

      </div>    
    </div>    
   )
}
export default UserInfo

간단히 설명하다면,

useKeycloak Hook를 통해 keycloak 개별 변수에 로그인 정보를 할당하고, accessToken값을 받아온다.

import { useKeycloak } from "@react-keycloak/web";
//....
//....
//....
      const { keycloak } = useKeycloak();
      
// keycloak를 통해 로그인이 되었을 경우 토큰값을 받게 된다.
//.....
      const accessToken = keycloak.idToken;

accessToken값이 있을 경우, 즉 정상 로그인이 되었을때, JWT구조상 split함수를 통해 PAYLOAD값을 가져와서

base64로 다시 decode를 한다. 

    if (accessToken) {
      payload = accessToken.split('.')[1];
      decodingInfo = base64.decode(payload);
    }

⌘ menu.jsx ( 위치: linkservice/client/src/component/menu.js )

---------------------------------------------------------------------------------------------------

이전 menu.jsx 소스를 임시로 수정하여 정보를 확인해보자.

import HomeIcon from '@mui/icons-material/Home';
import SettingsIcon from '@mui/icons-material/Settings';
import { useNavigate } from 'react-router-dom';
// useKeycloak import
import { useKeycloak } from "@react-keycloak/web";
import UserInfo from './userinfo';

export default function MenuIcon(props) {
    const navigator = useNavigate()
    
    // Using Object destructuring
    const { keycloak } = useKeycloak();

    const handleIcon = (e) => {
        switch (e) {
            case 'A' : 
                // keycloak에 로그인이 되어 있지 않다면, keycloak 로그인 페이지 호출
                if (!keycloak.authenticated) {
                    alert("로그인이 필요한 서비스입니다.")
                    // keycloak 로그인 페이지 호출시 redirectUri를 개인화가 가능하다.
                    keycloak.redirectUri= window.location.href + '/manager'
                    // keycloak 로그인 페이지 호출
                    keycloak.login();
                }

            return navigator('/manager')
            
            case 'M' : return navigator('/')
            default : return navigator('/')
        }
    }
    return (
<>
      <div className='menu-wrap'>
        <div className='menu-box'>
          <HomeIcon fontSize='large' color="secondary"
             onClick={() => handleIcon('M')} 
          />
          <SettingsIcon fontSize='large' color="secondary"
             onClick={() => handleIcon('A')} 
          /> 
        </div>
      </div>      

//임시로 반영.. 
//로그인되면 token값과 payload값을 보여준다.

      { keycloak.idToken ?
          <UserInfo /> 
        : null
      }
</>
    )
}

menu.jsx 마지막에 UserInfo 컨포넌트를 임시로 반영한다.

      { keycloak.idToken ?
          <UserInfo /> 
        : null
      }

그럼 로그인을 통해 idToken과 Token , 그리고 payload값을 출력해본다.

링크서비스 사이트에 로그인이 되어 token값과 playload정보를 볼수 있다.

또한, 개발자모드 console 에서는 auth token과 refresh token을 계속적으로 생성됨을 확인할수 있다.

동일하게  jwt.io 사이트에서도 확인해본다. 

두개를 비교해보면 동일한 결과값임을 알수 있다.

그럼 token정보에서 로그인 아이디, 이름 등 출력할때는 idTokenParsed 함수를 통해 다음과 같이 하면 한다.

아이디 정보를 알고 싶을때, 

keycloak.idTokenParsed.preferred_username

위와 같은 형태로 payload값을 중 하나를 가져오면 된다.

그럼 다음편에 계속..................................

그동안 17편을 거쳐서 웹 개발 React&Python으로 웹개발(링크서비스)를 개발 했으며, 

혼자 프론트/백엔드를 하다 보면 복잡함을 느끼며, 수정작업이 이루어지면 백엔드와 프론트엔드 여러 소스들을 거쳐서 관련 내용을 반영해야 하는 어려움이 있을 수 있다. 하지만, 반복적인 개발 과정을 통해서 여러분의 실력을 높일 수 있을 것이다.

최대한 STEP BY STEP로 소스를 추가하면서 설명하려고 노력했으나,

더 복잡해 졌는지 알 수 없지만, 일단 차근차근 따라해보면 좋을 듯 하다.

또한 본 소스를 공개하면서 여러분과 함께 WIN-WIN이 될 수 있을 거라고 믿으며, 수정과 발전을 해 가면서 여러분들 만의 레퍼런스 소스가 되길 바란다.

누구나 개발할 수 있는 소스이며, 단지 한번도 전체적인 개발 경험을 못한분들을 위한 것이므로, 완벽한 소스 내용이 아님을 다시 한번 말씀드리며, 제 1편을 마치고자 한다.

 링크서비스 git : https://github.com/firstvalue1/LINKSERVICE.git

보시다 수정이나, 의견 있으시면 git에 남겨주시기 바랍니다.

다음은 링크서비스를 기본으로 추가적인 기능들을 계속 게시 할 예정입니다.

링크서비스 등록화면에서 Input Value을 가져오는 방법을 알았다.

그럼 이미지 등록을 위한 Drag&Drop 이미지 업로드를 제작해보자.

#11. React화면에서 각 항목의 Input Value을 가져오기

⎟⎜이미지Drag Drop기능 및 Preview 기능

⌘ links.create.jsx ( 위치: linkservice/client/src/component/links.create.jsx)

---------------------------------------------------------------------------------------------------

1)   이미지를 미리 볼 수 있는 기능

     preview const 선언

const [preview, setPreview] = useState('assets/default.jpg')

📌 이미지가 없을 때 default이미지를 보여 주기 위해서 public/assets/default.jpg을 넣어둔다.

( 샘플 이미지는 인터넷 검색으로 적당한 곳에서 가져오면 된다.)

   img src 에 preview const을 지정

<div className="img_wrap" > 
            <img src =  {preview}
                alt='이미지' className="img_box" />
            <input multiple={false} name='imageurl'/>
 </div>

   handleChange() 함수에 target name이 imageurl일 경우 setPreview값을 셋팅 한다.

const handleChange = (e) => {
        const { name, value } = e.target
        setValues((prevValues) => ({
            ...prevValues,
            [name]: value,
        }))
        
       // 이 부분을 추가
        if (e.target.name === 'imageurl') {
            setPreview(e.target.value)
        }
    }

2)   이미지 Drag&Drop기능 구현

Drag Drop기능은 React에서 제공되는 react-dropzone 라이브러리를 사용한다.

📌 공식문서 : https://github.com/react-dropzone/react-dropzone

터미널에서 yarn add react-dropzone 라이브러리를 설치한 다음,

useDropzone을 선언한다.

import {useDropzone} from 'react-dropzone'

image state을 선언한다.

const [image, setImage] = useState(null)

onDrop 관련 함수를 작성한다.

onDrop함수는 이미지 drop후 처리해야 하는 작업내용을 반영하면 된다.

여기서는 파일을 읽어 처리는 로직을 반영 한다.

function onDrop(acceptedFiles) {
        const reader = new FileReader();
        const file = acceptedFiles
        
		// 이미지 파일을 읽어 setImage 로 저장
        if (file) {
          reader.readAsDataURL(file[0]);
          setImage(file[0]);
        }
       // onDrop되면 preview 되게 처리하고, 기존 이미지 url정보를 공백처리한다.
        reader.onload = (e) => {
            setPreview(reader.result);
            document.getElementsByName("imageurl")[0].value = ''
        };
    }

readAsDataURL 메소드로 image파일을 base64로 인코딩 된 값으로  반환한다. 그리고 그 결과를 setPreview(미리보기) 에 값을 넣고, setImage은 이미지 파일정보를 보관한다. 마지막으로 이미지를 직접 등록했으므로,

링크정보 URL(imageurl) 항목을 비운다.

Dropzone의 Props인 getRootProps와 getInputProps지정한다.

const {getRootProps, getInputProps} = useDropzone({onDrop})

이미지 영역(zone)의 div에 props들을 선언한다.

<div className="img_wrap" {...getRootProps()} > 
            <img src =  {preview}
                alt='이미지' className="img_box" />
            <input {...getInputProps()} multiple={false} name='imageurl'/>
</div>

📌(중요) getRootProps는 이미지 영역의 div에 ,    getInputProps는 input에 선언하면 된다.

이미지 저장하기 위해서 handleSubmit에 관련 내용을 추가한다.

이미지가 있을 경우 formData형태로 업로드를 진행한다.

linkService.createLink(values).then(
            (res) => {
                if (image) {
                    //이미지 항목이 있을경우 formData에 넣어 API을 호출한다.
                    formData.append('image', image)
                    linkService.uploadImage(formData).then(
                        (res)=> {// console.log(res) 
                        }
                )} 
                alert(res.data.message)
                window.location.reload();            
            }
        )

다음편에는 실제 DB 와 이미지 파일 저장 (등록) 기능을 만들어 보자.

#10. React 링크서비스 등록 및 편집 화면 개발(등록화면 디자인)

등록 및 편집화면 디자인이 되었으니, 이젠 입력 기능을 만들어 보자.

React화면에서 각 항목의 Input Value을 가져오기

⌘ links.create.jsx ( 위치: linkservice/client/src/component/links.create.jsx)

---------------------------------------------------------------------------------------------------

Input value값을 가져오는 방식은 아래 순서대로 처리 하시면 된다.

1)   input에서 value을 담기 위해서 state을 생성( json형태로 받기위해서 선언)

const [values, setValues] = useState({})

2)   input에서 값을 입력할 때 value state값을 변경해주는 onChange handle함수를 생성한다.

const handleChange = (e) => {
        const { name, value } = e.target
        setValues((prevValues) => ({
            ...prevValues,
            [name]: value,
        }))
}

위 코드는 input type=”text”에 입력하는 이벤트가 발생시 해당 input의 name과 value을 가져와 기존 state에 새로운 state을 추가하는 핸들 함수이다.

3) submit 핸들 함수를 통해 values의 validation체크와  API 호출하여 서비스에 전달하고,

      useRef을 통해 Input에 focus 주기

useRef선언

import React, { useState, useRef } from "react"

const 선언

const inputFocus = useRef(null)

 handleSubmit에 validation 체크 시 current focus()을 추가한다.

if (!values.name) {

     alert('링크명은 필수값입니다.')
     inputFocus.current.focus()

     return false

}

4)   handleSubmit 함수

const handleSubmit = async (e) => {

        e.preventDefault();

        const formData = new FormData();
        if (!values.name) {
            alert('링크명은 필수값입니다.')
            inputFocus.current.focus()
            return false
        }
        if (!image && !values.imageurl) {
            if (!window.confirm('이미지가 없는 링크정보를 등록하겠습니까?')) {
                return false
            }
         }
         
         // input 항목의 values을 db에 저장하는 API를 호출한다.
         
          linkService.createLink(values).then(
            (res) => {
                alert(res.data.message)
                window.location.reload();           
               }
           )
    }

5)   렌더링 되는 input에 onChange() 함수로 handleChange()함수를 호출한다.

<input type="text" name="name"
                defaultValue=""
                className="input-css"
                onChange={handleChange}
            />

6)   form 태그에 onSubmit 함수로 handleSubmit함수를 호출한다.

<form  onSubmit={handleSubmit}>

Input Value 작업은 이것으로 완료할 수 있으나,  추가적으로 이미지를 미리 볼 수 있는 기능,

이미지를 직접 Drag&Drop 하는 기능을 제작해보자.

#9. 초화면 디자인 ( CSS 적용 및 화면 Component제작 )

지금까지 Pytho Flask Restful API 와 React 로 링크서비스의 초화면을 제작했다.

앞으로 할일을 정리해서 하나씩 진행해 보기로 한다.

⎟⎜TO-DO

-       등록화면/편집화면 제작 ( 이미지 등록 포함 )

-       상단에 커버 이미지 추가 ( 커버 이미지 변경 포함 )

-       커버 이미지 구간에 일정을 표시 ( 일정관리 CRUD포함 )

-       Drag&Drop으로 링크 리스트 순서 변경 ( 모바일에서는 Touch )

-       태그 클라우드 표시 ( CRUD는 제외)

-       로그인 처리 ( 회원가입부분은 제외 )

-       구글애널리틱스(Google Analytics)와 연결

1.1. 등록화면 제작

⌘ links.create.jsx ( 위치: linkservice/client/src/component/links.create.jsx)

---------------------------------------------------------------------------------------------------

기본적인 등록 항목을 만든다. ( LinkCreateMain )

import React from "react";

export default function LinkCreateMain() {
  return (
<>
    <div>
        <h1>링크 등록</h1>
    </div>
    <div><label>링크명</label></div>
    <div><input type="text" name="name" /></div>
    <div><label>태그정보 ( 태그 여러개 등록시 / 로 구분 )</label></div>
    <div><input type="text" name="tag" /></div>
    <div><label>링크 URL (연결하고자 하는 URL)</label></div>
    <div><input type="text" name="linkurl" /></div>
    <div><label>사진 링크 정보</label></div>
    <div><input type="text" name="imageurl" /></div>

    <div><button type="submit">등록</button></div>
</>
  )
}

⌘ App.js에서 추가적으로 Route을 지정한다.

App.js에 Route추가 후 http://localhost:3000/create 로 접속해보자.

그래도 input box에 대한 디자인과 사진을 직접(PC) 등록할 수 있도록 등록화면을 좀 개선해 보겠다.

CSS에 아래 내용을 추가한다. ( links.css ) 

.title-container {
    display: flex;
    align-items: center;
    justify-content: space-between;
}
.text-title {
    text-align: center;
    font-size: 18px;
}
.input-wrap {
    display: flex;
    flex-direction: column;
    margin-top: 10px;
    margin-bottom: 20px;
}
.input-wrap > label {
    margin-bottom: 5px;
    font-size: 14px;
}
.input-box {
    height: 40px;
    width: 100%;
    position: relative;
}
.input-css {
    height: 44px;
    font-size: 14px;
    padding: 14px 12px;
    width: 100%;
    margin: 3px;
    box-sizing: border-box;
    color: #343434;
    border: 1px solid #d8d8d8;
    border-radius: 8px;
    background-color: bisque;
}

아래와 같은 링크명과 같이 input-wrap 안으로 다른 항목들도 모두 작성한다.

input-wrap > input-box > input-css 을 각 항목에 순차적으로 적용

일반 INPUT BOX는 위와 같이 적용하면 되나, 이미지 부분은 PC에 있는 이미지를 직접 등록할 수 있게 기능을 부여하기 위해서 아래 부분을 추가적으로 반영한다.

.img_contain {
    display: flex;
margin-top: 10px;
    margin-bottom: 20px;
}
.img_wrap {
    display: flex;
    width: 50%;
 }
.img_box {
    align-items: center;
    width: 100%;
    height: 150px;
    object-fit: cover;
    border-radius: 4px;
    background-position: 50%;
    background-repeat: no-repeat;
    background-size: cover;
    background-color: gray;
    cursor: pointer;
}
.text_type {
    display: flex;
    align-items: flex-end;
    margin-left: 10px;
  }

http://localhost:3000/create 로 확인해보자.

디자인이 어렵다면 bootstrap에 제공되는 form styles을 활용해도 된다

참고 : https://getbootstrap.com/docs/4.0/components/forms/

⎟⎜디자인 부분은 이정도로 끝내고 다음에는 기능 구현을 해보자.

#8. 프론트엔드 화면개발 (component 제작)

데이터까지 출력되는 것을 확인했으니, 이젠 디자인을 해보자.

⌘ links.css ( 위치: linkservice/client/src/css/links.css)

⌘ links.jsx ( 위치: linkservice/client/src/component/links.jsx)

---------------------------------------------------------------------------------------------------------

CSS을 위한 폴더를 만들고 links.css파일을 생성한다.

모든 CSS는 links.css에 넣어두었다.

link.css에 우선 link-container와 link-wrapper영역을 만들어주고,

.link-container {
    margin-bottom: 6px;
    cursor: move;
}
.link-wrapper {
    padding: 12px;
box-shadow: 0em 0em 0.1em #000000;
    border-radius: 10px;
}

link-show 영역에는 link image와 link name이 보여주도록 한다.

.link-show {
    display: flex;
    align-items: center;
}
.link-img {
    width: 40px;
    height: 40px;
    border-radius: 50%;
    object-fit: cover;
}
.link-title {
    flex-direction: column;
    margin-left: 10px;
min-width: 200px;
    width: 70%;
    font-weight: 600;
}

⌘ links.jsx에서 CSS을 import하고 CSS들을 적용해본다.

⎮결과화면

링크정보를 여러 개 등록해서 확인해 본다.

JSON 데이터 중 활용하지 않는 항목을 추가적으로 화면에 적용해보자.

⎮링크정보 걸기

link-show 부분에 onClick이벤트를 추가한다.

이젠 클릭하면 linkurl항목의 정보에 따라 페이지 이동이 된다.

⎮태그정보 표시

link-wrapper 부분에 tag 표시를 해보자.

태그는 여러 개가 있을 수 있으나, 여기서는 최대 3개까지만 입력이 가능(화면 제약사항) 하고,

태그의 구분자는 / 로 해서 구분한다. (예,  태그1/태그2/태그3 )

태그의 내용을 표시해준다.

태그 관련 css을 추가한다

.tag-container {
    display: flex;
    flex-wrap: nowrap;
}
.tag-row {
    flex-basis: 90px;
}
.tag-button {   
    flex-basis: 21%;
    height: 20px;
    border-radius: 6px;
    margin-right: 15px;
    text-align: center;
    font-size: 4px;
    color: rgb(218, 213, 213);
}
.tag-blue {
    background-color: rgb(82, 65, 234); 
}

마지막 태그는 제주도/귤/할인 여러 개로 되어 있기 때문에 분할을 해야 한다.

그리고 여러 개 태그도 각각 색상을 다르게 버튼을 만들어 보자.

tag button 색상을 다르게 하기 위해서 classList에 다른 색상을 담아 적용해보자.

참고로, 조금 다른 방식으로child component인 TagList(Props)을 만들어 렌더링을 하는 방식도 있다.

위 소스에서 누락된 게 하나 있다.

바로 tag 값이 없을 경우도 빈 항목에 tag-orange css가 적용되어 버린다.

그래서 tag값이 있을 경우만 렌더링 되도록 조건을 하나 더 줘서 해결한다.

!tag 을 or 조건으로 추가한다.

!tag || tag.split('/').map( (tag, index)=>

물론 child function인 TagList(Props)을 안하고,

LinkMain()에서 바로 렌더링을 해도 무방한다. 아래 같은 식으로 해도 결과는 같으니 소스 참고만 하길 바란다.

개발 소스 방식은 여러가지 방식이다. 뭐가 옳다, 그르다 을 판단하는 것은 맞지 않다. 단, 좀더 가독성과 Performance, 유지보수 등을 고려하여 회사기준 혹은 개발자들과 협업해서 코딩 기준에 맞춰서 개발하면 된다.

이젠, 색상관련 css를 추가하자.

.tag-orange {
    background-color: rgb(200, 173, 108);
}
.tag-grin {
    background-color: rgb(18, 161, 139); 
}

실제 복잡하다고 볼 수 있지만, 전체적으로 포맷만 이해한다면 다른 사이트를 구축하는데 많은 도움이 될 것으로 생각된다.

하지만, 여러가지 기능을 추가하면서 어려웠던 기억이 있어서 이제부터

TO-DO 리스트를 만들어 하나씩 완성해보자.

( 화면설계를 다시 한번 참고하길 바란다.)

다음편에는 링크서비스의 등록화면을 제작해보자.

#7. 프론트엔드 화면 개발

1.1. Component 제작 ( React로 API 호출 )

이제부터 컴포넌트를 하나씩 작성해 보자.

React에서 Axios를 이용해 API 호출하기

컴포넌트는 크게 3가지로 구분하여 작성했다.

1.    API URL을 관리하는 api.config.js

2.    AXIOS로 API을 호출하여 리턴 받는 service.js

3.    service을 받아 화면에 출력해주는 컴포넌트들

디렉토리는 src 밑에 /component 에 /api 와 /service 로 나눈다.

⌘ api.config.js ( 위치: linkservice/client/src/component/api/api.config.js)

----------------------------------------------------------------------------------------------

Python Server에서 개발한 API 호출 URL을 관리한다. 

API가 많아지면 별도 관리 하는게 유지보수상 좋다.

export const API = {
    //LINKS 서비스 API  
    LINKSALL: `/api/links`,
    LINKREGISTER: `/api/link/create`,
    LINKSELECT: `/api/link/select/`,
    LINKDELETE: `/api/link/delete/`,
    LINKUPATE: `/api/link/update`,
}

⌘ service.js ( 위치: linkservice/client/src/component/service/service.js)

------------------------------------------------------------------------------------------------

service.js는 각 API 호출을 담당하는 함수들을 모아둔 서비스로,

axios 로 API을 호출하여 값을 return받도록 함수를 정의하고, 외부에서 호출할 수 있도록 linkService로 지정한다.

import axios from "axios"
import { API } from "../api/api.config"

// ####### 링크정보 API 호출
const getLinks = () => {
    return axios.get(API.LINKSALL)
}
const getSelectLink = (id) => {
    return axios.get(API.LINKSELECT + id)
}
const createLink= (values) => {
    return axios.post(API.LINKREGISTER, values)
}
const updateLink = (id, values) => {
    return axios.put(API.LINKUPATE + id, values)
}
const deleteLink = (id) => {
    return axios.put(API.LINKDELETE + id)
}
const linkService = {
    getLinks,
    getSelectLink,
    createLink,
    updateLink,
    deleteLink,
}
export default linkService;

1.2.  화면 출력

화면 소스는 .jsx 확장자로 생성했다.

⌘ links.jsx ( 위치: linkservice/client/src/component/links.jsx)

--------------------------------------------------------------------------------------------------

component안에 API을 호출하여 리턴 받은 값을 화면에 출력해보자.

useEffect을 통해 linkService의 getLinks(전체링크목록조회)을 호출하는 로직이다.

rendering되는 return값에 <></> Fragment축약으로 감싸 있는 것을 확인하기 바란다.

import React, { useState, useEffect } from "react"
import linkService from "./service/service"

export default function LinkMain() {
    const [data, setData] = useState([])

    useEffect(() => {
        linkService.getLinks().then(
        (res)=> {
            setData(res.data)
           console.log(res.data)
        }, (error) => {
           alert(error.res.data.message )
        }
        )
    }, [])
    
    return (
<> 
     <div>
       { data.links && data.links.map((links) => (

        <div key={links.id}> 
            <div >id : {links.id}</div>
            <div>name : {links.name}</div>
            <div>tag : {links.tag}</div>
            <div>imageurl : {links.imageurl}</div>    
            <div>linkurl : {links.linkurl}</div>   
        </div>
                                                              
        ))}
     </div>
 </> 
    ) // return
} // function

links.jsx의 LinkMain()을 App.js에서 Router을 지정하여 호출해보자.

⌘ App.js ( 위치: linkservice/client/src/App.js)

-------------------------------------------------------------------------------------------------------

import React from "react"
import { BrowserRouter, Route, Routes } from "react-router-dom"
import LinkMain from "./component/links"

function App() {
  return (
    <BrowserRouter>    
      <Routes>
        <Route exact path="/" element={<LinkMain />} />  
      </Routes> 
    </BrowserRouter>
  );
}
export default App;

터미널을 열어서 yarn start을 실행해보자. 하지만, 모듈 오류가 날것이다.

관련 모듈을 설치 안 해서 나는 것으로 우선 모듈 설치를 하자.

$ yarn add react-router-dom

$ yarn add axios

$yanr start

모듈 설치 후 실행하면 빈 화면에 브라우저 개발자 모드에 보면 404오류가 발생한다.

오류 Url을 보면 API 호출 시 발생한다.

React에서 백엔드 서버로 API 요청 시 Proxy 설정을 해줘야 정상 호출이 된다.

우리는 Python Flask로 API을 구현 했으므로, Python Server단을 호출할 수 있도록 설정하면 된다.

⎮Proxy 설정

client의 package.json 열어 proxy설정을 추가한다.

"proxy": "http://0.0.0.0:5000",

   📌 아이피를 127.0.0.1로 설정안하고, 0.0.0.0 로 설정한 이유는 클라우드 환경(AWS, CAFE24등) 경우 내부 IP가 192.168로 시작될 수 있어서 모든 IPv4 인터페이스를 설정하고자 0.0.0.0로 했다.

이제 실행해보자

⎮실행방법

    -       서버 ( $ linkservice/server ) 터미널

          1.    python 가상화 실행 ( source ./bin/activate )

          2.    python3 server.py 실행

          3.    POSTMAN을 통해서 샘플 데이타를 입력한다. 

          ► POST /api/link/create - 링크정보 등록 참고

#6. Python으로 API 개발(API Resource선언 및 테스트)

-       클라이언트 ( $ linkservice/client ) 터미널

       1.    yarn start 실행

브라우저에서 http://localhost:3000 으로 확인해보자.

정상적으로 출력됨을 확인할 수 있다.

📌 links.jsx 소스에 API을 통해 JSON을 제대로 받아오는지 확인하고자 useEffect 부분에 console.log을 찍어 브라우저

     개발자모드에 console에 {links: Array(1)} 가 보인다.

화면이 이쁘지 않아, 다음 포스팅에는 디자인을 해보자.

1.    React로 화면 개발

자, 이제부터 REACT로 화면을 개발 해보자.

앞에서 사전 준비시 프로젝트 폴더인 linkservice아래에 npx create-react-app 으로 이미 client을 생성했다.

#4. 프로젝트 폴더 구조 및 환경설정

1.1.  React 기본설정

기본 폴더구조에서 필요 없는 파일을 모두 지운다.

      · public 폴더 밑에 index.html을 제외하고 모두 삭제

      · src 폴더 밑에 App.js, index.js 을 제외하고 모두 삭제

React 파일 구조를 간단히 설명한다면,

1. index.js

src 폴더에 메인 Script로 여기에서 HTML 템플릿 및 JavaScript의 컴포넌트를 조합하여 렌더링을 한다.

2. App.js

src 폴더에 컴포넌트를 정의하는 Script이다. 실제로 화면에 표시되는 내용 등은 여기에서 정의된다.

3. index.html

public 폴더에 있으며, HTML 템플릿 파일이다. 이 파일이 직접 표시되는 것은 아니고, index.js에 의해 렌더링 된 결과가 표시된다.

   📌 App.js에서 컴포넌트를 정의하고 -> index.js 에서 ReactDOM.rendor 하고  -> index.html에서 표시된다.

먼저, App.js 을 수정한다.

아래 코드에서 필요 없는 내용 지우고, 다음과 같이 추가 한다.

index.js 에서 reportWebVitals 부분과 import index.css을 주석처리 한다.

   📌 참고로, reportWebVitals는 Create React App에서 서드파트 라이브러리로 Index 파일에 써 있는 것처럼

       reportWebVitals() 에 console.log을 넣어주면 개발창을 통해 앱의 퍼포먼스 시간들을 분석하여 object형태로

      보여준다.

이젠 터미널에서 yarn start을 실행하고, 브라우저에서 접속해보자.

1.2. 디자인 가져오기

디자인까지 하면 1인 개발자로 가장 이상적이만, 그만큼 많은 노력이 필요하다. 나도 디자인 만큼은 많이 배우지 못해서 얕은 지식으로 화면을 만들어 보기로 했다.

디자인이 필요 없는 분들은 디자인 설명부분을 제외하고, 개발부분만 봐도 된다.

우선 Bootstrap 무료 디자인을 가지고 와서 변경해보고자 한다.

디자인 참조 : https://getbootstrap.com/docs/5.3/examples/

우리는 Album화면을 가지고 시작하고자 한다. https://getbootstrap.com/docs/5.3/examples/album/ 접속후 오른쪽 마우스 클릭해서 페이지 소스보기에서 HTML을 복사하여 index.html에 붙여 넣는다.

Title등 텍스트 부분을 빼거나, 수정하시고, HTML에서 본문에 해당되는 <main></main> 과 <footer></footer> 는 삭제하고 나머지 부분에서 필요한 부분은 추가/수정/삭제해서 초기 화면을 구성해보자

<main></main> 부분이 가장 중요하므로, 소스내 확인하기 바란다.

<!doctype html>
<html lang="ko">

<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no, maximum-scale=1">
  <meta name="description" content="">
  <meta name="generator" content="Hugo 0.88.1">
  <title>링크서비스</title>

  <!-- Bootstrap core CSS -->
  <link href="https://getbootstrap.kr/docs/5.1/dist/css/bootstrap.min.css" rel="stylesheet"
    integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
</head>

<body>
  <header>
    <div class="collapse bg-dark" id="navbarHeader">
      <div class="container">
        <div class="row">
          <div class="col-12">
            <h4 class="text-white">링크서비스</h4>
            <p class="text-muted">개발은 엄연히 존중 받아야 할 개인의 창작물입니다. 
            </p>
          </div>
        <div class="col-12">
          <h6 class="text-white">Developers</h4>
          <ul class="list-unstyled">
            <li class="text-muted">(주)XXXXXXXX</li>
            <li class="text-muted">사업자번호:XXX-XX-xxxxx</li>
            <li class="text-muted">대표전화:000-1111-2222</li>            
          </ul>
        </div>
      </div>

      </div>
    </div>
    <div class="navbar navbar-dark bg-dark shadow-sm">
      <div class="container">
        <a href="/" class="navbar-brand d-flex align-items-center">
          <svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" fill="none" stroke="currentColor"
            stroke-linecap="round" stroke-linejoin="round" stroke-width="2" aria-hidden="true" class="me-2"
            viewBox="0 0 24 24">
            <path d="M23 19a2 2 0 0 1-2 2H3a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h4l2-3h6l2 3h4a2 2 0 0 1 2 2z" />
            <circle cx="12" cy="13" r="4" />
          </svg>
          <strong>링크서비스</strong>
        </a>
        <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbarHeader"
          aria-controls="navbarHeader" aria-expanded="false" aria-label="Toggle navigation">
          <span class="navbar-toggler-icon"></span>
        </button>
      </div>
    </div>
  </header>


  <main>
    <!-- 배경이미지 처리 -->
    <section class="container" id="section">
    </section>    

    <div class="album py-4 bg-light" >
      <div class="container" id="root">
            <!--   여기에 본문내용을  처리 -->
      </div>
    </div>
  </main>
  <!-- <footer class="text-muted py-2" id="footer">
  </footer> -->
</body>
</html>

📌 디자인 및 퍼블리싱이 가능하신 분들은 각자 다른 디자인으로 해도 무방하다.

이젠 화면이 잘 출력되는지 확인 한다.

다음편에는 Component제작을 해보자.

#6. Python으로 API 개발(데이타베이스 모델 작업)

이전 포스팅에 데이타베이스 모델링 작업을 했고, 여기서는  server.py에 flask_restful에서 제공되는

API Resource을 추가해 보자.

⌘ server.py ( 위치: linkservice/server/server.py)

----------------------------------------------------------------------------------------------------------

기존 server.py 에 추가해보자.

import socket
from config.create_app import create_app
from flask import Flask
    #flask_restful에서 API와  src 밑에 links.py에 class들을 import 한다.
from flask_restful import Api
from src.links import LinkRegister, LinksAll, LinkSelect, LinkRemove, LinkUpdate
from db_init import db

env = socket.gethostbyname(socket.gethostname())
if 'linkservice.com' in env :
   app = create_app('production')
else:
   app = create_app('development')
# print(app.config)
    # API 선언
api = Api(app)
    #API에 Resource를 추가한다.
api.add_resource(LinkRegister, '/api/link/create')
api.add_resource(LinksAll, '/api/links')
api.add_resource(LinkSelect, '/api/link/select/<int:id>')
api.add_resource(LinkRemove, '/api/link/delete/<int:id>')
api.add_resource(LinkUpdate, '/api/link/update/<int:id>')

if __name__ == "__main__":
# ORM
    db.init_app(app)
    app.run(debug=True, port=5000)

저장 후 이제 실행해서 확인해보자.

⎮실행방법

   1.     터미널에서 가상화 실행 ( source ./bin/activate )

   2.     python3 server.py 실행

   3.     POSTMAN에서 API 테스트

실행후 POSTMAN에서 테스트를 해보자.

1.1.  API 테스트

☑︎ POST /api/link/create - 링크정보 등록

          Body에 JSON으로 데이터를 넣고 진행해보자.

message을 정상적으로 return 받는지 확인한다.

☑︎ GET /api/links – 전체 링크정보 조회

☑︎ GET /api/link/select/<int:id>        - ID에 해당한 링크정보조회

☑︎ PUT /api/link/update/<int:id>           - name을 수정해보자.

☑︎ DELETE /api/link/delete/<int:id> - ID에 해당한 링크정보 삭제

LINKS 테이블에 대한 CRUD API가 완성되었다.

주요 테이블인 LINKS의 CRUD API가 완성되었으므로, 프론트엔드에서 실제 화면을 구현을 해보고, 아직까지 DB및 API설계에 빠진 것은 화면을 개발하면서 추가적으로 제작해 보기로 한다.

1. 기본 설계

간단한 프로그램이지만, 프로젝트 매니저나 기획자처럼, 개발 이전에 어느정도 설계가 되어야 개발의 일관성이 생긴다.

혼자서 프론트엔드와 백엔드 개발을 하게 되어 실제 내용이 어설프더라도 양해해주기 바랍니다.

화면은 디자인이 되었지만, 사실 개발하면서 퍼블리싱을 했고, 그 단계 단계를 앞으로 보여줄 예정이다.

IT기업을 다닐 때는 이 모든 것을 산출물 형태로 파워포인트와 엑셀로 작업을 했지만, 요즘은 스케치(Sketch), 피그마(Figma), XD와 같은 인터페이스 디자인을 위한 협업 웹 애플리케이션 등이 많지만, 기 사용해본 Figma을 통해 간단히 UI설계를 진행 했다. UI부문도 보통 기업에서는 디자인팀에서 제작하여 주기 때문에 개발시에 부담이 덜 할 수 있으나, 디자인이 약한 나는 CSS에서 많은 시간을 허비했다.

여러 사이트의 CSS을 참고하여 나름대로 만든 것으로, 퍼블리싱에 능한 분이라고 나름 수정하셔서 사용해도 무방하다

1.1. DB 설계

UI 설계된 기준으로 DB 설계를 해보자. 또한 기본적인 로그인 처리를 위한 테이블도 구성한다.

  1) Link정보를 저장하는 테이블 ( links )

  2) 워드 클라우드를 표시하기 위한 테이블( tagcloud )

       ▷ 워크 클라우드는 별도 구현 안 해도 되며, 향후 필요시 소스만 참고하기 바란다.

3) 일정을 등록( 행사오픈일정 등 )을 위한 테이블 ( plans )

       ▷ 화면 커버 이미지에 일정이 표시될 예정이다.

4) 로그인을 위한 유저정보 테이블 ( user )

1.2. API정의

각 DB 테이블의 기본 CRUD을 API로 정의하고, 로그인 처리, 회원가입처리, 이미지 처리를 위한 기본 API을 추가했다.

모든 API을 미리 기록해두고 싶지만, 설명을 위해서 여기서 정의되지 않은 API 는 개발 과정에서 추가할 예정입니다.

다음편에 계속........