Rails를 사용하여 JS 위젯을 원활하게 포함: 단계별 가이드

클라이언트 웹사이트에 삽입할 수 있는 사용자 정의 JavaScript 위젯을 만드는 것은 Ruby on Rails 애플리케이션의 범위를 확장하는 강력한 방법입니다. 채팅 상자, 분석 추적기, 기타 대화형 요소 등 사용자 정의 위젯을 사용하면 사용자에게 직접 기능을 제공할 수 있습니다. 안전하고 삽입 가능한 위젯을 구축하는 단계를 살펴보고 모범 사례를 살펴보겠습니다.

목차

 1. 1단계: 설정
 2. 2단계: 클라이언트용 삽입 코드 생성
 3. 3단계: Iframe에 위젯 삽입(선택 사항)
 4. 4단계: Iframe 삽입을 위한 헤더 설정
 5. 5단계: 위젯 테스트
 6. 6단계: 버전이 지정된 경로 및 컨트롤러를 사용하여 버전 지원 추가

1단계: 설정

새 Rails 엔드포인트 생성: 이 엔드포인트는 위젯에 대한 JavaScript 코드를 제공합니다. 일반적으로 이는 WidgetsController 내의 작업일 수 있습니다.

# app/controllers/widgets_controller.rb
class WidgetsController 



<p>경로 구성: 위젯에 액세스할 수 있도록 경로를 설정하세요.<br>
</p>

<pre class="brush:php;toolbar:false"># config/routes.rb
Rails.application.routes.draw do
  get '/widget.js', to: 'widgets#show', as: :widget
end

컨트롤러에서 JavaScript 제공: Rails에서는 적절한 콘텐츠 유형을 설정하여 JavaScript로 응답할 수 있습니다.

# app/controllers/widgets_controller.rb
class WidgetsController 



<p>위젯용 JavaScript 코드 작성: 위젯 스크립트에는 일반적으로 클라이언트 페이지에 사용자 정의 HTML 요소 또는 iframe을 렌더링하는 로직이 포함되어 있습니다.<br>
</p>

<pre class="brush:php;toolbar:false">// app/views/widgets/show.js.erb
(function() {
  const widgetDiv = document.createElement('div');
  widgetDiv.id = 'custom-widget';
  widgetDiv.innerHTML = "<p>This is your custom widget content!</p>";
  document.body.appendChild(widgetDiv);
})();

2단계: 클라이언트용 포함 코드 생성

클라이언트가 위젯을 삽입할 수 있도록 하려면 복사하여 HTML에 붙여넣을 수 있는 JavaScript 스니펫을 제공하세요.

<!-- Client Embeddable Code -->
<script type="text/javascript">
  (function() {
    const script = document.createElement('script');
    script.src = "https://yourapp.com/widget.js";
    script.async = true;
    document.head.appendChild(script);
  })();
</script>

3단계: Iframe에 위젯 삽입(선택 사항)

스타일을 더욱 격리하고 제어하려면 iframe에 위젯 콘텐츠를 삽입하는 것이 좋습니다. 이 접근 방식은 위젯의 스타일과 동작을 클라이언트 사이트와 별도로 유지합니다.

위젯용 iframe을 생성하려면 JavaScript 코드를 업데이트하세요.

// app/views/widgets/show.js.erb
(function() {
  const iframe = document.createElement('iframe');
  iframe.src = "";
  iframe.style.width = "300px";
  iframe.style.height = "200px";
  document.body.appendChild(iframe);
})();

위젯 콘텐츠에 대한 새 경로 및 보기를 정의합니다.

# config/routes.rb
Rails.application.routes.draw do
  get '/widget_content', to: 'widgets#content', as: :widget_content
end

# app/controllers/widgets_controller.rb
def content
  render layout: false
end

위젯 콘텐츠 HTML 생성: iframe 내부에서 렌더링할 뷰 생성

<!-- app/views/widgets/content.html.erb -->
<div>



<h2>
  
  
  Step 4: Setting Headers for Iframe Embedding
</h2>

<p>Configure the appropriate HTTP headers to ensure your widget works securely in an iframe. There are two primary headers to consider:</p>

<p><strong>Remove the X-Frame-Options Header</strong>: The X-Frame-Options header is deprecated but still widely respected by many browsers. To remove it, add the following configuration in an initializer:<br>
</p>

<pre class="brush:php;toolbar:false"># config/initializers/security_headers.rb
Rails.application.config.action_dispatch.default_headers.delete('X-Frame-Options')

Frame-Ancestors 지시어 설정:보다 현대적이고 유연한 접근 방식은 Frame-ancestors 지시어와 함께 Content-Security-Policy를 사용하는 것입니다. 아이프레임. 보안 요구 사항에 따라 필요에 따라 이 헤더를 조정하세요.

# config/initializers/security_headers.rb
Rails.application.config.action_dispatch.default_headers.merge!({
  'Content-Security-Policy' => "frame-ancestors 'self' https://trusted-domain.com"
})

이 구성을 사용하면 지정된 도메인에 의해서만 앱이 iframe에 삽입될 수 있습니다. https://trusted-domain.com을 신뢰하는 실제 도메인으로 바꾸세요.

5단계: 위젯 테스트

위젯과 헤더를 설정한 후 다양한 브라우저의 테스트 페이지에 위젯을 삽입하여 테스트하여 호환성을 확인하세요. 프레임 상위 항목을 사용한 경우 지정된 도메인만 위젯을 삽입할 수 있고 위젯이 예상대로 표시되는지 확인하세요.

6단계: 버전이 지정된 경로 및 컨트롤러를 사용하여 버전 지원 추가

위젯이 발전함에 따라 모든 클라이언트가 즉시 채택할 준비가 되지 않은 새로운 기능이나 개선 사항을 도입할 수도 있습니다. 여러 버전의 위젯을 지원하면 이전 버전과의 호환성이 보장되므로 고객이 기존 통합을 중단하지 않고 원하는 속도로 업그레이드할 수 있습니다.

버전이 지정된 경로 및 컨트롤러를 사용하여 버전 지원 구현

버전이 지정된 경로 정의

위젯의 각 버전에 대해 별도의 경로를 설정하는 것부터 시작하세요. 각 버전의 네임스페이스를 사용하면 코드를 체계적으로 정리하고 다양한 버전을 독립적으로 관리할 수 있습니다.

# app/controllers/widgets_controller.rb
class WidgetsController 



<h4>
  
  
  버전이 지정된 컨트롤러 생성
</h4>

<p>각 버전에 대해 해당 네임스페이스 내에 컨트롤러를 만듭니다. 이렇게 분리하면 한 버전의 변경 사항이 다른 버전에 영향을 주지 않습니다.<br>
</p>

<pre class="brush:php;toolbar:false"># config/routes.rb
Rails.application.routes.draw do
  get '/widget.js', to: 'widgets#show', as: :widget
end

# app/controllers/widgets_controller.rb
class WidgetsController 



<h4>
  
  
  버전별 JavaScript 및 HTML 보기 생성
</h4>

<p>각 버전에는 고유한 JavaScript 및 HTML 파일이 있으므로 버전별로 기능과 모양을 맞춤 설정할 수 있습니다.</p>

<p><strong>버전 1 자바스크립트:</strong><br>
</p>

<pre class="brush:php;toolbar:false">// app/views/widgets/show.js.erb
(function() {
  const widgetDiv = document.createElement('div');
  widgetDiv.id = 'custom-widget';
  widgetDiv.innerHTML = "<p>This is your custom widget content!</p>";
  document.body.appendChild(widgetDiv);
})();

버전 1 콘텐츠:

<!-- Client Embeddable Code -->
<script type="text/javascript">
  (function() {
    const script = document.createElement('script');
    script.src = "https://yourapp.com/widget.js";
    script.async = true;
    document.head.appendChild(script);
  })();
</script>

버전 2 콘텐츠:

// app/views/widgets/show.js.erb
(function() {
  const iframe = document.createElement('iframe');
  iframe.src = "";
  iframe.style.width = "300px";
  iframe.style.height = "200px";
  document.body.appendChild(iframe);
})();

최종 생각

Rails 애플리케이션용 삽입 가능 위젯을 만들려면 JavaScript를 안전하게 제공하고, 스타일을 관리하고, iframe 호환성을 위해 헤더를 올바르게 구성하는 등 몇 가지 주요 고려 사항이 필요합니다. 위의 단계를 따르면 고객이 사이트에 쉽게 추가할 수 있는 위젯을 갖게 되어 Rails 애플리케이션의 유용성을 확장할 수 있습니다.