소셜 구성 요소 프레임워크 social-component-framework

SCF(소셜 구성 요소 프레임워크)를 사용하면 서버측과 클라이언트측 모두에서 커뮤니티 구성 요소를 구성, 사용자 지정 및 확장하는 프로세스를 단순화할 수 있습니다.

프레임워크의 이점:

대화형 커뮤니티 구성 요소 가이드를 사용하여 작성자 또는 게시 인스턴스를 탐색합니다.

개요 overview

SCF에서 구성 요소는 SocialComponent POJO, Handlebars JS Template(구성 요소를 렌더링함) 및 CSS(구성 요소의 스타일을 지정함)로 구성됩니다.

Handlebars JS 템플릿은 모델/보기 JS 구성 요소를 확장하여 클라이언트의 구성 요소와 사용자 상호 작용을 처리할 수 있습니다.

구성 요소가 데이터 수정을 지원해야 하는 경우 기존 웹 애플리케이션의 모델/데이터 개체와 유사한 데이터의 편집/저장을 지원하도록 SocialComponent API의 구현을 작성할 수 있습니다. 또한 작업 요청을 처리하고 비즈니스 논리를 수행하며 모델/데이터 개체에 대한 API를 호출하기 위해 작업(컨트롤러) 및 작업 서비스를 추가할 수 있습니다.

SocialComponent API는 클라이언트가 보기 계층 또는 HTTP 클라이언트에 필요한 데이터를 제공하도록 확장될 수 있습니다.

클라이언트용 페이지 렌더링 방법 how-pages-are-rendered-for-client

구성 요소 사용자 지정 및 확장 component-customization-and-extension

구성 요소를 사용자 정의하거나 확장하려면 /apps 디렉토리에 오버레이 및 확장만 작성하여 향후 릴리스로 업그레이드하는 프로세스를 간소화합니다.

서버측 프레임워크 server-side-framework

프레임워크는 서버의 기능에 액세스하고 클라이언트와 서버 간의 상호 작용을 지원하는 API를 제공합니다.

Java™ API java-apis

Java™ API는 쉽게 상속되거나 하위 클래스화되는 추상 클래스 및 인터페이스를 제공합니다.

기본 클래스는 서버측 사용자 지정 페이지에 설명되어 있습니다.

UGC 작업에 대해 알아보려면 저장소 리소스 공급자 개요를 참조하세요.

HTTP API http-api

HTTP API는 PhoneGap 앱, 기본 앱 및 기타 통합 및 매쉬업에 대한 간편한 사용자 지정 및 클라이언트 플랫폼 선택을 지원합니다. 또한 HTTP API를 사용하면 커뮤니티 사이트를 클라이언트 없이 서비스로 실행할 수 있으므로 프레임워크 구성 요소를 모든 기술에 구축된 웹 페이지에 통합할 수 있습니다.

HTTP API - GET 요청 http-api-get-requests

모든 SocialComponent에 대해 프레임워크는 HTTP 기반 API 끝점을 제공합니다. 끝점은 '.social.json' 선택기 + 확장을 사용하여 리소스에 GET 요청을 전송하여 액세스됩니다. Sling을 사용하면 요청이 DefaultSocialGetServlet에 전달됩니다.

DefaultSocialGetServlet

GET Request

기본 GET 서블릿은 SocialComponent가 사용자 지정 가능한 JSON으로 응답하는 .social.json 요청을 수신합니다.

HTTP API - POST 요청 http-api-post-requests

GET(읽기) 작업 외에도 프레임워크는 구성 요소에서 만들기, 업데이트 및 삭제를 비롯한 다른 작업을 활성화하는 엔드포인트 패턴을 정의합니다. 이러한 끝점은 입력을 수락하고 HTTP 상태 코드 또는 JSON 응답 개체로 응답하는 HTTP API입니다.

이 프레임워크 엔드포인트 패턴을 통해 CUD 작업을 확장, 재사용 및 테스트할 수 있습니다.

POST Request

모든 SocialComponent 작업에 대한 Sling POST:작업이 있습니다. 각 작업에 대한 비즈니스 논리 및 유지 관리 코드는 HTTP API를 통해 또는 다른 곳에서 OSGi 서비스로 액세스할 수 있는 OperationService에 래핑됩니다. 전/후 작업에 대한 플러그형 작업 확장을 지원하는 후크가 제공됩니다.

저장소 리소스 제공자(SRP) storage-resource-provider-srp

커뮤니티 콘텐츠 저장소에 저장된 UGC를 처리하는 방법에 대한 자세한 내용은 다음을 참조하세요.

서버측 사용자 지정 server-side-customizations

서버측에서 Communities 구성 요소의 비즈니스 논리 및 동작을 사용자 지정하는 방법에 대한 자세한 내용은 서버측 사용자 지정을 참조하십시오.

Handlebars JS 템플릿 언어 handlebars-js-templating-language

새 프레임워크에서 눈에 띄는 변경 사항 중 하나는 서버 클라이언트 렌더링에 널리 사용되는 오픈 소스 기술인 Handlebars JS(HBS) 템플릿 언어를 사용하는 것입니다.

HBS 스크립트는 간단하고 논리를 사용하지 않으며, 서버와 클라이언트에서 컴파일하고, 오버레이와 맞춤화가 쉽고, HBS가 클라이언트측 렌더링을 지원하므로 클라이언트 UX와 자연스럽게 바인딩됩니다.

프레임워크는 SocialComponents를 개발할 때 유용한 몇 가지 Handlebars 도우미를 제공합니다.

서버에서 Sling은 GET 요청을 확인하면 요청에 응답하는 데 사용되는 스크립트를 식별합니다. 스크립트가 HBS 템플릿(.hbs)인 경우 Sling은 요청을 Handlebars 엔진에 위임합니다. 그런 다음 Handlebars 엔진은 적절한 SocialComponentFactory에서 SocialComponent를 가져와서 컨텍스트를 빌드하고 HTML을 렌더링합니다.

액세스 제한 없음 no-access-restriction

Handlebars(HBS) 템플릿 파일(.hbs)은 클라이언트 브라우저와 서버 모두에서 렌더링하는 데 사용할 수 있다는 점을 제외하면 .jsp 및 .html 템플릿 파일과 유사합니다. 따라서 클라이언트측 템플릿을 요청하는 클라이언트 브라우저는 서버로부터 .hbs 파일을 수신하게 됩니다.

이를 위해서는 작성자 또는 게시의 모든 사용자가 sling 검색 경로의 모든 HBS 템플릿(https://experienceleague.adobe.com/libs/%20%EB%98%90%EB%8A%94%20/apps%20%EC%95%84%EB%9E%98%EC%9D%98%20%EB%AA%A8%EB%93%A0%20.hbs%20%ED%8C%8C%EC%9D%BC?lang=ko)을 가져올 수 있어야 합니다.

.hbs 파일에 대한 HTTP 액세스를 금지할 수 없습니다.

커뮤니티 구성 요소 추가 또는 포함 add-or-include-a-communities-component

대부분의 Communities 구성 요소는 Sling 주소 지정 가능 리소스로 추가 ​되어야 합니다. 사용자 생성 콘텐츠(UGC)를 작성할 위치를 동적으로 포함 및 사용자 지정할 수 있도록 하기 위해 일부 커뮤니티 구성 요소가 존재하지 않는 리소스로 템플릿에 포함 ​될 수 있습니다.

두 경우 모두 구성 요소의 필수 클라이언트 라이브러리도 있어야 합니다.

구성 요소 추가

구성 요소 추가는 구성 요소 브라우저(사이드 킥)에서 작성자 편집 모드의 페이지로 드래그한 경우와 같이 리소스(구성 요소)의 인스턴스를 추가하는 프로세스를 의미합니다.

그 결과 Sling 주소 지정 가능한 par 노드 아래에 JCR 하위 노드가 있습니다.

구성 요소 포함

구성 요소를 포함한다는 것은 스크립팅 언어를 사용하는 것과 같이 템플릿 내에서 "존재하지 않는" 리소스(JCR 노드 없음)에 대한 참조를 추가하는 프로세스를 말합니다.

Adobe Experience Manager(AEM) 6.1부터는 구성 요소가 추가되는 대신 동적으로 포함되면 작성자 디자인 모드에서 구성 요소의 속성을 편집할 수 있습니다.

AEM Communities 구성 요소 중 선택한 일부만 동적으로 포함될 수 있습니다. 이는 다음과 같습니다.

커뮤니티 구성 요소 안내서를 통해 포함 가능한 구성 요소를 추가에서 포함으로 전환할 수 있습니다.

Handlebars 템플릿 언어를 사용하는 경우 resourceType을 지정하여 include helper을(를) 사용하여 존재하지 않는 리소스를 포함합니다.

{{include this.id path="comments" resourceType="social/commons/components/hbs/comments"}}

JSP를 사용할 때, 태그 cq:include를 사용하여 리소스가 포함됩니다.

<cq:include path="votes"
 resourceType="social/tally/components/voting" />

Handlebars 도우미 handlebars-helpers

SCF에서 사용할 수 있는 사용자 지정 도우미의 목록과 설명은 SCF Handlebars 도우미를 참조하십시오.

클라이언트측 프레임워크 client-side-framework

모델 보기 JavaScript 프레임워크 model-view-javascript-framework

프레임워크에는 풍부한 대화형 구성 요소를 쉽게 개발할 수 있도록 모델 보기 JavaScript 프레임워크인 Backbone.js의 확장이 포함되어 있습니다. 객체 지향 속성은 확장/재사용 가능한 프레임워크를 지원합니다. 클라이언트와 서버 간의 통신은 HTTP API를 통해 간소화됩니다.

프레임워크는 서버측 Handlebars 템플릿을 사용하여 클라이언트의 구성 요소를 렌더링합니다. 이 모델은 HTTP API에서 생성된 JSON 응답을 기반으로 합니다. 보기는 Handlebars 템플릿에서 생성된 HTML에 바인딩되며 상호 작용을 제공합니다.

CSS 규칙 css-conventions

다음은 CSS 클래스를 정의하고 사용하기 위한 권장 규칙입니다.

클라이언트측 사용자 지정 client-side-customizations

클라이언트측에서 커뮤니티 구성 요소의 모양 및 동작을 사용자 지정하려면 다음에 대한 정보가 포함된 클라이언트측 사용자 지정을 참조하십시오.

기능 및 구성 요소 기본 사항 feature-and-component-essentials

개발자를 위한 필수 정보는 기능 및 구성 요소 필수 패키지 섹션에 설명되어 있습니다.

추가 개발자 정보는 코딩 지침 섹션에서 찾을 수 있습니다.

문제 해결 troubleshooting

일반적인 문제 및 알려진 문제는 문제 해결 섹션에 설명되어 있습니다.