Legacy 웹 사이트에 Progressive Web App 적용하기 (Part I)

Why did I start to work on this project?

  • 배경 : 팀내에서 고객과의 질의응답 채널로 포탈 사이트를 운영하고 있다.
  • 현상 : 포탈 사이트가 개발된지 약 2년이 된 것 같은데 (소스를 보니 2014년에 만들어진 것으로 추정), 시대를 역행하는 Non Responsive Design 과 고객 Q&A에 Notification 기능이 없어 수시로 사이트 접속하여 게시글과 댓글을 모니터링 해야하는 불편함이 있었다.
  • 계획 : Mobile 에서도 간단한 게시글 확인 및 알람 기능을 추가하여 사용성을 늘리기로 결정했고, Progressive Web 의 몇가지 기능들을 넣어보기로 결정했다.

What is Progressive Web App?

  • 구글에서 최근에 밀어붙이는 웹앱으로 Responsive Design, App Like, Re-engagable, Installable, Safe, … 등의 특징과 함께 빠른 로딩과 높은 사용자 경험을 제공하는 것이 특징이다.
  • Mobile 에서만 지원되었던 Push 알림, Mobile Icon, 앱 설치 배너 등을 웹 어플리케이션에서 지원하기 때문에, 일반 웹 개발로 Mobile Application 의 Appy 한 느낌을 낼 수 있다.
  • 자세한 내용은 Google Web Fundamental 참고

Non Responsive to Responsive Design

  • 기존에 적용된 UI Framework 은 반응형이 지원되지 않는 Bootstrap 이다. 무슨 이유에서인지 모르겠으나 반응형 지원을 하지 않고, 철저히 PC 기준으로만 사이트를 제작하였다. 아마도, 모바일에서의 화면 Layout 까지 고려하기에는 시간이 빠듯했거나, 요구사항 자체가 Mobile 에서도 볼 수 있게 해달라는 요청이 없었기 때문인 것 같다.
  • Boostrap 외에도 jstree, jquery-ui, jquery-remodal, jquery-multifile, NHN Smart Editor 등의 외부 라이브러리들을 가져다가 화면을 구성해놓았다.

레거시 사이트 UI

1365 * 600 해상도 PC 화면

pc_login
PC 로그인 페이지
  • 그냥 로그인 기능만 되면 문제 없어보이는 UI…

 

pc_main
PC 게시판 목록
  • 전체적으로 균형은 잘 잡혀 있어 보인다.

 

pc_list
PC 트리 선택 후 게시판 이동
  • 왼쪽 트리를 펼쳐 게시판 목록을 펼친다.

 

pc_viewpost
PC 게시글 조회
  • 게시판 질의 응답 기능에만……. 충실한 화면 Layout 과 UI

iPhone 6 브라우저 화면

1
Mobile 로그인 페이지
  • 로그인 페이지는 그럭저럭 봐줄만 하다.

 

2
Mobile 게시판 목록
  • 모바일에서 보는 게시판 페이지는 거의 재앙에 가깝다.

 

3
페이지 확대해서 트리 선택
  • 페이지를 이동하려면 왼쪽 트리를 클릭해야 하는데, 페이지 확대를 해서 저 작은 리스트를 클릭해야 페이지 이동이 된다… 참 난감하다.

 

4
Mobile 에서 게시글 조회
  • 게시글 조회 시 게시글과 답변 모두 확대 하지 않고는 보기가 거의 불가능하다.

 

Re-designing UI & UX with Critical User Journeys

  • 지난 6월 Google Campus 에서 진행된 UI & UX 워크샵에서 배운 “Critical User Journeys” 기법을 이번 사이트에 적용 해보았다.
  • Critical User Journeys : 사용자의 입장에서 해당 서비스를 사용할 때 모든 동작에 대해 UI 와 Layout 을 고려하고 이를 기반으로 UI Design 을 가다듬는 것.
  • UI 개선을 위해 가장 첫 번째로 해야할 질문들 (The very first thing to do is ask these questions)
  1. Who is using your website? 누가 사이트를 사용하는가?
  2. When are they using their website? 사용자들은 사이트를 언제 사용하는가?
  3. Why are they using the website? 사용자들은 왜 사이트를 사용하는가?
  4. Where are they using the website? 사용자들이 사이트를 어디에서 사용하는가?
  • 사이트를 사용하는 유저 입장에서, 로그인 절차부터 게시판 및 기타 기능들을 사용할 때 까지 위의 질문들을 염두에 두고 다음과 같이 개편하였다.
  1. Mobile First Design
  2. 버튼에 아이콘을 추가하여 직관화
  3. 글쓰기 / 글읽기 / 답글달기 할 때 보여지는 기능들의 우선순위를 정하여 UI 컴포넌트 재배치
  4. 게시글 정보를 중요도 순으로 다시 배치하고 간결하게 표현
  5. 댓글에 자신의 사진을 표시하여 책임감 및 흥미 부여 (화장실에 담당자 사진 걸어놓는 것과 동일한 목적)
  6. 전체적인 Tone & Manner 를 맞추기 위해 기존 jsTree 라이브러리 제거 후 Collapsible 과 Collection 으로 트리 구현

개선된 사이트 UI

15인치 노트북 PC에 최적화된 화면

new_pc_login
PC 로그인 페이지
  • MaterializeCSS 의 기본 Login Template 을 적용했다.

 

new_pc_list
PC 게시글 목록
  • UI 의 전체적인 느낌을 통일하기 위해 왼쪽 jstree 라이브러리를 걷어내고, collipsible & collection 조합으로 왼쪽에 트리를 구현하였다.

 

new_pc_viewpost
PC 게시글 조회
  • 글 수정 / 삭제 / 목록 등의 버튼에 아이콘을 이용하여 직관적인 표시를 하였고, 답글과 댓글 영역을 명확히 분리하였다. 댓글 리스트는 우선순위 기준으로 정보를 재배치 및 계정에 프로필 사진을 추가하여, 댓글 구분이 쉽도록 하였다.

 

new_pc_delete
게시물 삭제시 권한 확인 팝
  • 기존 화면의 불필요한 영역을 차지하는 ID & PW 를, 게시글을 삭제할 때 확인하도록 변경했다.

 

iPhone 6 브라우저 화면

new_mobile_login
Mobile 로그인 페이지
  • PC Login 화면에서 크기만 작아진다.

 

new_mobile_main
Mobile 메인 페이지
  • 로그인 후 메인화면, 모바일에서는 폴더 트리를 Global Navigation 으로 뺐다.

 

new_mobile_list
Mobile 게시글 목록 페이지
  • 게시글 목록은 다음과 같이 표시된다. 테이블 cell 의 더 세부적인 css 스타일링으로 가독성을 높이는 작업이 더 필요한 것 같다.

 

new_mobile_tree
Mobile 네비게이션 바
  • Global Navigation Bar 를 이용하여 페이지 간 이동을 한다.

 

new_mobile_viewpost
Mobile 게시글 조회
  • Mobile 에서 유용하게 사용할만한 보기 & 댓글 기능에 주안점을 두고, 가독성을 높이는데 주력했다.

 

Back-End Service Analysis

기술 및 기법

  • 기존의 시스템은 Spring FW 3.4 로 구성이 되어 있었고, 다음과 같은 기술 및 기법 들을 쓰고 있었다.
  • Spring Security : 권한 관리를 위한 스프링 기술스택
  • Controller Annotation in bean.xml : base.package 에 지정된 패키지 안에 해당되는 모든 @Controller 에 대해 처리해준다.
  • ControllerAdvice Annotation in bean.xml : 위와 동일한 성격으로, 여기서는 Controller 에서 발생하는 에러 케이스 들에 대한 Exception 처리를 지정해주었다.
  • Multipart Resolver in beans.xml : 파일 또는 이미지를 Client 에서 Stream 방식으로 서버로 보낼 때, Stream 형식으로 받아 처리해줄 수 있는 Resolver
  • JDBC Template in applicationContext.xml : 스프링에서 DB 연결시 사용하는 전형적인 스프링 JDBC 연결방법
  • DataSource Transcation Manager in applicationContext.xml : 스프링에서 제공하는 다양한 Transaction Manager중의 하나
  • DBCP DataSource in applicationContext.xml : DB와 어플리케이션을 효율적으로 연결하는 커넥션 풀을 제공. 일정 커넥션을 유지하다가 필요하면 사용하고 반납하여 재사용하는 형태

문제점

  • 기존 레거시 시스템의 가장 큰 문제점은 특정 주기 간격으로, 서비스가 올라가 있는 Tomcat 을 주당 2회 정도 계속 재시작을 해줘야 했다.
  • 그 이유를 진단하기 위해 아래 쿼리를 넣었고
show status like `%connect%`;
  • 진단 결과는 다음과 같았다.

“페이지 마다 수행되는 쿼리에 대해서 커넥션이 닫히지 않고, 계속 커넥션 수가 누적된다.”

Back-End Service Refactoring

안티패턴 1

  • 위와 같은 문제점을 해결하기 위해 구현된 Spring 로직을 분석한 결과, 다음과 같은 안티패턴을 발견했다.
@Controller
public class BoardController extends ExceptionControllerAdvice {

private BoardService getBoardService() {
ApplicationContext context = new GenericXmlApplicationContext("applicationContext.xml");
return context.getBean("boardService", BoardService.class);
}

// ...
}
  • 위의 안티패턴은 해당 컨트롤러가 수행이 될 때 마다, ApplicationConext 를 매번 생성하여 메모리 낭비 및 DB 커넥션 수를 불필요하게 늘리게 된다.
  • 해결책 : ApplicationContext는 WAS (Web Application Server) 에 Spring Container가 올라가는 최초에만 생성되고, 이후에는 생성된 Context 를 공유하는 형식으로 바꿨다.
@Controller
public class BoardController extends ExceptionControllerAdvice {

@Autowired
private BoardService boardService; // Application Context 에서 생성된 BoardService 를 참조한다.

// ...
}

안티패턴 2

  • Controller.java 에서 해당 URL에 관한 로직을 처리 후 URL redirect 을 다음과 같이 한 안티패턴이 발견되었다.
@RequestMapping(value = "replyBoard", method = RequestMapping.POST)
public String replyBoard(
HttpSession session,
@RequestParam("folder") String folder,
@RequestParam("subCategory") String subCategory, ... ) throws UserException {
ModelAndView mv = new ModelAndView;
mv.addObject("folder",folder);
mv.addObject("subCategory",subCategory);
// ...

return "redirect:/viewPost?folder="+folder+"&subCategory="+subCategory;
}
  • ModelAndView 를 사용하여 redirect 를 할 경우에는 ModelAndView 에 추가된 Object 변수들이 redirect 시에 자동으로 붙지 않는다. 따라서, 이를 아래와 같이 Model model 을 이용하면,
@RequestMapping(value = "replyBoard", method = RequestMapping.POST)
public String replyBoard(
HttpSession session,
@RequestParam("folder") String folder,
@RequestParam("subCategory") String subCategory, Model model ) throws UserException {
model.addObject("folder",folder);
model.addObject("subCategory",subCategory);
// ...

return "redirect:/viewPost";
}

// URL 결과 : `viewPost?folder="folder"&subCategory="subCategory"`
  • 위처럼 Model 을 이용하여 View에 데이터를 넘겨주면, redirect 시에 자동으로 변수가 붙게되는 이점이 있다.

Progressive Web App Native Feature 적용은 Part 2 에서 이어집니다…

Advertisements

Service Worker Introduction II

Service Worker 실행하기 위한 환경

  • 지원되는 브라우저 : Chrome 46 ↑, Firefox, Opera, Safari (지원예정)
  • 브라우저 지원에 대한 상세한 내용은 여기 참고
  • HTTPS 통신이 가능한 서버에서만 동작한다 (테스트를 위한 localhost 제외)

Service Worker 등록하기

  • 아래 코드처럼 javascript로 서비스워커를 등록한다.
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/sw.js').then(function(registration) {
    // Registration was successful
    console.log('ServiceWorker registration successful with scope: ', registration.scope);
  }).catch(function(err) {
    // registration failed 😦
    console.log('ServiceWorker registration failed: ', err);
  });
}
  • 위 코드를 살펴보면, 먼저 서비스워커 API 존재 유무를 파악한다.
  • 존재할 시에 /sw.js 파일을 등록한다.
  • 한가지 알아둘 것은, 페이지가 로딩될 때 마다 register() API를 호출해도 된다. 브라우저가 서비스워커 실행 유무를 판단하여 알아서 처리하기 떄문이다.
  • 서비스워커 파일은 도메인 루트에 위치한다. 예를 들어, 도메인이 /example/sw.js 인 경우, /example/로 시작하는 모든 도메인에 대하여 서비스워커가 실행된다.
  • 크롬브라우저 주소창에 chrome://inspect /#service-workers 입력하면 서비스워커 콘솔을 사용할 수 있다.
  • 등록된 서비스워커는 chrome://serviceworker-internals 을 통해 확인 및 관리 할 수 있다.

Service Worker 설치하기

  • 위 등록 절차를 거쳤다면, 이젠 서비스워커에서 사용할 자원들을 설치할 차례다.
  • 아래 코드를 이용하여 어떤 파일들을 캐싱할 것인지 결정한다.
self.addEventListener('install', function(event) {
  // Perform install steps
});
  • install 콜백 함수 안에 다음 3가지 순서를 추가한다.
    1. [열기] cache 열기
    2. [캐싱] 사용할 파일들 캐싱하기
    3. [확인] 해당 파일들이 모두 캐싱 되었는지 확인
var CACHE_NAME = 'my-site-cache-v1';
var urlsToCache = [
  '/',
  '/styles/main.css',
  '/script/main.js'
];

self.addEventListener('install', function(event) {
  // Perform install steps
  event.waitUntil(
    caches.open(CACHE_NAME)
      .then(function(cache) {
        console.log('Opened cache');
        return cache.addAll(urlsToCache);
      })
  );
});
  • caches.open()에 정의한 캐쉬명 변수를 이용하여 캐쉬 사용을 시작한다.
  • 다음 cache.addAll()를 이용하여 array 안에 선언한 필요파일들을 모두 캐싱한다.
  • event.waitUntil() 메서드로 설치가 얼마나 오래 걸리던 간에, 설치 후에 해당 이벤트를 수행할 수 있도록 한다. (Javascript Promise 사용됨)
  • 결론적으로, 모든 파일들이 성공적으로 캐싱되면 서비스워커가 정상적으로 설치된다.
  • 주의할 점은, 여기서 한 개의 파일이라도 캐싱에 실패할 경우 인스톨 전체의 프로세스가 종료된다는 것이다. 따라서 신중하게 캐싱할 파일 리스트를 정한다.

Cache 와 Return 요청

  • 서비스워커 설치까지 완료했다면, 이제 캐쉬된 결과를 받아볼 차례다
  • 설치 완료후에 페이지 이동이나 갱신을 하게 되면, 서비스워커는 fetch라는 이벤트를 수행하게 된다.
self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit - return response
        if (response) {
          return response;
        }
        return fetch(event.request);
      }
    )
  );
});
  • caches.match()는 들어오는 request에 대해서 서비스워커가 생성한 캐쉬가 있는지 확인한다
  • 만약 생성된 캐쉬가 있다면, 캐쉬 값을 리턴한다. 그렇지 않은 경우에는 fetch() 를 콜한다.
  • fetch() 네트워크로부터 받을 데이터가 있다면, 네트워크 요청을 보내 해당 데이터를 받는다.
  • 네트워크 요청을 각각 캐쉬로 저장하고 싶다면, 아래와 같은 형식으로 구현하면 된다.
self.addEventListener('fetch', function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit - return response
        if (response) {
          return response;
        }

        // IMPORTANT: Clone the request. A request is a stream and
        // can only be consumed once. Since we are consuming this
        // once by cache and once by the browser for fetch, we need
        // to clone the response.
        var fetchRequest = event.request.clone();

        return fetch(fetchRequest).then(
          function(response) {
            // Check if we received a valid response
            if(!response || response.status !== 200 || response.type !== 'basic') {
              return response;
            }

            // IMPORTANT: Clone the response. A response is a stream
            // and because we want the browser to consume the response
            // as well as the cache consuming the response, we need
            // to clone it so we have two streams.
            var responseToCache = response.clone();

            caches.open(CACHE_NAME)
              .then(function(cache) {
                cache.put(event.request, responseToCache);
              });

            return response;
          }
        );
      })
    );
});

위 코드의 로직은 다음과 같다.

  1. fetch reqeust에 대해 promise (then) 콜백 호출
  2. 받은 response에 대하여 아래와 같은 절차를 수행
    • response 유효성 검사
    • status 값이 200인지 확인
    • type 값이 basic인지 확인 (our origin 인지 확인 / 3rd party 자원은 캐쉬가 되지 않는다는 의미)
  3. 위 절차들을 통과하면, response를 복제한다. 이유는 response는 Stream 방식이기 떄문에, body는 오직 한번만 실행 가능하다. 캐쉬 후에 브라우저에도 response를 던져야 하기 때문에, 복제를 해서 한개는 캐쉬를 한개는 브라우저에 각각 사용한다.

Service Worker 업데이트 하기

  • 서비스워커를 업데이트 해야하는 시점에서의 작업 절차는 다음과 같다.
    1. 서비스워커를 업데이트 하라. 사용자가 사이트를 네비게이팅 할 떄, 서비스워커 파일이 1byte라도 다를 경우 새로운 서비스워커로 간주한다.
    2. 새로운 서비스 워커가 시작되고, install 이벤트가 발생한다.
    3. 이 시점에서, 예전에 등록된 서비스워커가 현재 페이지를 제어하고 있기 때문에 새로운 서비스 워커는 waiting 상태로 진입한다.
    4. 사이트에서 열려있었던 페이지가 닫히면, 이전 서비스워커는 종료되고 새로운 서비스워커가 제어를 넘겨받는다
    5. 새로운 서비스워커로 제어가 넘어오면, activate 이벤트가 발생된다.
  • activate 콜백에서 발생하는 가장 흔한 작업은 cache management이다.
  • 이유는 바로 install 단계에서 이전 캐쉬를 다 지우게 된다면, 현재 페이지의 제어를 담당하는 old 서비스워커(현재 페이지에서 사용되고 있는 서비스워커 : 새로운 서비스워커에 비교해 old로 간주)의 경우 캐쉬에서 파일을 제공할 수가 없기 때문이다.
  • 예를 들어, my-site-cache-v1 캐쉬라는 파일이 있다고 가정하자. 그리고 이 캐쉬를 한개는 페이지에 한개는 블로그 포스트에 사용한다고 하자.
  • 이 의미는 install 단계에서 pages-cache-v1blog-posts-cache-v1 라는 두개의 캐쉬를 생성하고, 기존의 my-site-cache-v1 캐쉬는 지운다 는 것이다.
  • 아래의 코드를 확인해보면, cacheWhitelist에 존재하지 않는 캐쉬는 모두 서비스워커에서 삭제한다.
self.addEventListener('activate', function(event) {

  var cacheWhitelist = ['pages-cache-v1', 'blog-posts-cache-v1'];

  event.waitUntil(
    caches.keys().then(function(cacheNames) {
      return Promise.all(
        cacheNames.map(function(cacheName) {
          if (cacheWhitelist.indexOf(cacheName) === -1) {
            return caches.delete(cacheName);
          }
        })
      );
    })
  );
});

Rough Edges and Gotchas (현재 떠안고 있는 문제들)

서비스워커에는 현재 다음 두가지 이슈가 있다. 설치 실패 여부 확인 어려움, fetch() 디폴트 값

  1. 설치 실패 여부 확인 어려움
    • 서비스워커가 등록이 되더라도, chrome://inspect/#service-workerschrome://serviceworker-internals 로 확인하기 어렵다.
    • 따라서, chrome://serviceworker-internals 에서 Open DevTools window and pause JavaScript execution on service worker startup for debugging.를 체크하여 install event에 디버깅 문구를 넣어 확인한다.
  2. fetch() 디폴트 값
    • No Credentials by Default : fetch() 이벤트를 default로 사용시에는 쿠키 같은 credential들을 포함하지 않는다. 만약 credential을 포함하고 싶다면 아래와 같이
    fetch(url, {
    credentials: 'include'
    })
    
    • Non-CORS Fail by Default : 3rd party URL을 통한 자원 획득은 허용되지 않는다(CORS 지원하지 않는다면). 만약 CORS를 지원하려면 no-CORS 옵션을 추가한다. 하지만 이 방법은 opaque 응답을 야기하는데, 받은 응답이 성공인지 실패인지 확인할 수 가 없는 단점이 있다.
    cache.addAll(urlsToPrefetch.map(function(urlToPrefetch) {
    return new Request(urlToPrefetch, { mode: 'no-cors' });
    })).then(function() {
    console.log('All resources have been fetched and cached.');
    });
    

Service Worker Introduction I

Service Worker 란 무엇인가

  • Rich offline experiences, periodic background syncs, push notifications 등 네이티브 앱에서만 가능했던 기능들을 웹에서 사용할 수 있도록 지원하는 스크립트
  • 웹 페이지와는 별개로 브라우저의 백그라운드에서 수행되는 스크립트
  • 오늘 기준으로 push notificationsbackground sync 를 지원한다.
  • 오프라인 사용에 대한 완벽한 지원을 한다
  • Service Worker 이전에는 SPA의 AppCache 와 같은 기능들이 존재 했었지만, multiple page에 대한 지원이 되지 않았다.

Service Worker 를 통해 할 수 없는 것들은?

  • Javascript Worker 이기에 DOM 에 직접 접근이 불가. (하지만 원하면 postMessage 와의 인터페이스를 통해 접근 가능)
  • 프로그래밍 가능한 네트워크 프록시이기 떄문에, 페이지 핸들링에 관련된 네트워크 요청을 제어할 수 있다.
  • 사용하지 않을 때는 종료된다. 따라서, onfetch & onmessage 핸들러를 통한 global state에 접근이 불가능 하지만, 원한다면 IndexedDB API를 이용하여 상태를 보존할 수 있다.

Service Worker Lifecycle

  • 웹 페이지와 완전 별개의 라이프싸이클을 갖고 있다.
  • [등록] 서비스워커 사용을 위해서는 먼저 페이지의 자바스크립트를 사용하여 등록해야 한다.
  • [설치] 설치하는 과정에서 static한 자원들을 캐싱하고, 캐싱이 완료되면 서비스 워커가 설치가 된다. 한 개의 파일일라도 캐싱에 실패하면, 설치가 종료되고, 서비스워커는 다시 활성화되지 않는다.
  • [활성] 설치가 되고 나면, 활성 스텝으로 넘어오고, 이 떄 이전(오래된) 캐쉬들을 다룰 수 있는 상태가 된다.
  • [제어] 활성화 스텝 이후에는 서비스 워커가 본격적으로 모든 페이지를 제어하기 시작한다. 서비스워커에게 제어권이 돌아가면, 보통 아래 2가지 상태(Fetch, Terminated)로 나뉘게 된다.
  • [페치/메시지] 네트워크 요청을 받거나 메시지를 페이지로부터 전달받았을 때 데이터를 fetch하거나 메시지 이벤트를 처리한다
  • [종료] 메모리 효율을 위해 서비스워커를 종료한다

Service Worker Overview Imagesw-lifecycle

Service Worker Reference