서버 사이드 렌더링 (SSR)

TIP

Nuxt.js를 사용하는 경우, 이 섹션 대신 Nuxt.js를 읽어야 합니다.

피니아로 스토어를 만드는 것은 setup 함수, getters, actions의 상단에서 useStore() 함수를 호출하는 한 SSR에서 즉시 사용할 수 있습니다:

vue

<script setup>
// 이것은 피니아가 `setup()`
// 내부에서 실행 중인 앱이라는 것을 알고 있으므로 작동함.
const main = useMainStore()
</script>

<script setup>
// 이것은 피니아가 `setup()`
// 내부에서 실행 중인 앱이라는 것을 알고 있으므로 작동함.
const main = useMainStore()
</script>

`setup()` 외부에서 스토어 사용

다른 곳에서 스토어를 사용해야 하는 경우, 앱에 전달된 pinia 인스턴스를 useStore() 함수 호출에 전달해야 합니다:

const pinia = createPinia()
const app = createApp(App)

app.use(router)
app.use(pinia)

router.beforeEach((to) => {
  // ✅ 이렇게 하면 현재 실행 중인 앱의 저장소가 사용됨.
  const main = useMainStore(pinia)

  if (to.meta.requiresAuth && !main.isLoggedIn) return '/login'
})

const pinia = createPinia()
const app = createApp(App)

app.use(router)
app.use(pinia)

router.beforeEach((to) => {
  // ✅ 이렇게 하면 현재 실행 중인 앱의 저장소가 사용됨.
  const main = useMainStore(pinia)

  if (to.meta.requiresAuth && !main.isLoggedIn) return '/login'
})

피니아는 앱에 $pinia로 추가되므로, 편리하게 serverPrefetch()와 같은 함수에서 사용할 수 있습니다:

export default {
  serverPrefetch() {
    const store = useStore(this.$pinia)
  },
}

export default {
  serverPrefetch() {
    const store = useStore(this.$pinia)
  },
}

onServerPrefetch()를 사용할 때 특별한 작업을 수행할 필요가 없습니다:

vue

<script setup>
const store = useStore()
onServerPrefetch(async () => {
  // ✅ 작동함
  await store.fetchData()
})
</script>

<script setup>
const store = useStore()
onServerPrefetch(async () => {
  // ✅ 작동함
  await store.fetchData()
})
</script>

상태 하이드레이션

초기 상태를 하이드레이션하려면, 피니아가 나중에 rootState를 선택할 수 있도록, rootState가 HTML의 어딘가에 포함되어 있는지 확인해야 합니다. SSR에 사용하는 항목에 따라 보안상의 이유로 상태를 이스케이프해야 합니다. Nuxt.js에서 사용하는 @nuxt/devalue를 사용하는 것이 좋습니다:

import devalue from '@nuxt/devalue'
import { createPinia } from 'pinia'
// retrieve the rootState server side
const pinia = createPinia()
const app = createApp(App)
app.use(router)
app.use(pinia)

// after rendering the page, the root state is built and can be read directly
// on `pinia.state.value`.

// serialize, escape (VERY important if the content of the state can be changed
// by the user, which is almost always the case), and place it somewhere on
// the page, for example, as a global variable.
devalue(pinia.state.value)

import devalue from '@nuxt/devalue'
import { createPinia } from 'pinia'
// retrieve the rootState server side
const pinia = createPinia()
const app = createApp(App)
app.use(router)
app.use(pinia)

// after rendering the page, the root state is built and can be read directly
// on `pinia.state.value`.

// serialize, escape (VERY important if the content of the state can be changed
// by the user, which is almost always the case), and place it somewhere on
// the page, for example, as a global variable.
devalue(pinia.state.value)

SSR에 사용하는 항목에 따라 HTML에서 직렬화될 초기 상태 변수를 설정합니다. 또한 XSS 공격으로부터 자신을 보호해야 합니다. 예를 들어, vite-ssr을 사용하면, transformState 옵션 및 @nuxt/devalue를 사용할 수 있습니다;

import devalue from '@nuxt/devalue'

export default viteSSR(
  App,
  {
    routes,
    transformState(state) {
      return import.meta.env.SSR ? devalue(state) : state
    },
  },
  ({ initialState }) => {
    // ...
    if (import.meta.env.SSR) {
      // this will be stringified and set to window.__INITIAL_STATE__
      initialState.pinia = pinia.state.value
    } else {
      // on the client side, we restore the state
      pinia.state.value = initialState.pinia
    }
  }
)

import devalue from '@nuxt/devalue'

export default viteSSR(
  App,
  {
    routes,
    transformState(state) {
      return import.meta.env.SSR ? devalue(state) : state
    },
  },
  ({ initialState }) => {
    // ...
    if (import.meta.env.SSR) {
      // this will be stringified and set to window.__INITIAL_STATE__
      initialState.pinia = pinia.state.value
    } else {
      // on the client side, we restore the state
      pinia.state.value = initialState.pinia
    }
  }
)

필요에 따라 @nuxt/devalue의 다른 대안을 사용할 수 있습니다. 예를 들어 JSON.stringify()/JSON.parse()로 상태를 직렬화하고 파싱할 수 있다면, 성능을 크게 향상시킬 수 있습니다.

이 전략을 환경에 맞게 조정하십시오. 클라이언트 측에서 useStore() 함수를 호출하기 전에 피니아의 상태를 하이드레이션해야 합니다. 예를 들어 상태를 <script> 태그로 직렬화하여, window.__pinia를 통해 클라이언트 측에서 전역적으로 접근할 수 있도록 하려면 다음과 같이 작성합니다:

const pinia = createPinia()
const app = createApp(App)
app.use(pinia)

// must be set by the user
if (isClient) {
  pinia.state.value = JSON.parse(window.__pinia)
}

const pinia = createPinia()
const app = createApp(App)
app.use(pinia)

// must be set by the user
if (isClient) {
  pinia.state.value = JSON.parse(window.__pinia)
}

서버 사이드 렌더링 (SSR) ​

setup() 외부에서 스토어 사용 ​

상태 하이드레이션 ​

서버 사이드 렌더링 (SSR)

`setup()` 외부에서 스토어 사용

상태 하이드레이션