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

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

프레임워크의 이점:

대화형 기능을 사용하여 작성자 또는 게시 인스턴스에서 탐색 커뮤니티 구성 요소 안내서.

개요 overview

SCF에서 구성 요소는 SocialComponent POJO, Handlebars JS 템플릿(구성 요소를 렌더링하기 위한) 및 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 서블릿은 사용자 지정 가능한 JSON으로 SocialComponent가 응답하는 .social.json 요청을 수신합니다.

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

GET(읽기) 작업 외에 프레임워크는 엔드포인트 패턴을 정의하여 만들기, 업데이트 및 삭제 등 구성 요소에서 다른 작업을 수행할 수 있도록 합니다. 이러한 종단점은 HTTP 상태 코드 또는 JSON 응답 개체를 사용하여 입력을 받아들이고 응답하는 HTTP API입니다.

이 프레임워크 종단점 패턴은 CUD 작업을 확장, 재사용 및 테스트 가능하게 합니다.

POST Request

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

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

에 저장된 UGC를 처리하는 방법에 대해 알아보려면 커뮤니티 콘텐츠 저장소를 참조하십시오.

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

방문 서버측 사용자 지정 를 참조하십시오.

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

새로운 프레임워크의 가장 주목할 만한 변경 사항 중 하나는 Handlebars JS 서버 클라이언트 렌더링을 위한 널리 사용되는 오픈 소스 기술인 템플릿 언어(HBS)

HBS는 클라이언트 측 렌더링을 지원하므로 HBS 스크립트는 간단한 논리 없이 서버 및 클라이언트 모두에서 컴파일되고 오버레이 및 사용자 지정이 쉽고 클라이언트 UX와 자연스럽게 바인딩됩니다.

프레임워크는 다음과 같은 몇 가지 기능을 제공합니다 Handlebars 도우미 Social 구성 요소를 개발할 때 유용합니다.

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

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

HBS(Handlebars) 템플릿 파일(.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 대응 가능 리소스로 사용합니다. 몇 가지 Communities 구성 요소 선택 포함 UGC(사용자 생성 컨텐츠)를 작성할 위치의 동적 포함 및 사용자 지정을 허용하는 기존 리소스가 아닌 리소스로 템플릿에 있습니다.

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

구성 요소 추가

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

그 결과, JCR 하위 노드가 par 노드 아래에 있으며, 이 노드는 Sling 대응 가능 합니다.

구성 요소 포함

구성 요소를 포함시키는 것은 "비기존" 리소스 (JCR 노드 없음) 스크립트 언어 사용과 같이 템플릿 내에서 사용할 수 있습니다.

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

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

다음 커뮤니티 구성 요소 안내서 포함 가능한 구성 요소를 포함하도록 전환할 수 있습니다.

Handlebars 사용 시 템플릿 언어인 비기존 리소스는 도우미 포함 resourceType을 지정하여 다음을 수행합니다.

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

JSP 사용 시 ​를 채울 때는 태그를 사용하여 리소스가 포함됩니다 cq:include:

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

Handlebars Helpers handlebars-helpers

자세한 내용은 SCF Handlebars Helpers SCF에서 사용할 수 있는 사용자 지정 도움말 목록 및 설명.

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

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

프레임워크는 Backbone.js는 모델 뷰 JavaScript 프레임워크로서 풍부하고 대화형 구성 요소의 개발을 용이하게 합니다. 객체 지향 특성은 확장/재사용 가능한 프레임워크를 지원합니다. 클라이언트와 서버 간의 통신은 HTTP API를 통해 단순화됩니다.

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

CSS 규칙 css-conventions

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

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

클라이언트측에서 커뮤니티 구성 요소의 모양과 동작을 사용자 지정하기 위해 를 참조하십시오 클라이언트측 사용자 지정:

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

개발자를 위한 필수 정보는 기능 및 구성 요소 핵심 사항 섹션을 참조하십시오.

개발자 추가 정보는 코딩 지침 섹션을 참조하십시오.

문제 해결 troubleshooting

일반적인 우려와 알려진 문제는 문제 해결 섹션을 참조하십시오.