Mastering Data Fetching with Next.js SWR: A Comprehensive Guide

Next.js SWR is a powerful React Hooks library for data fetching, providing an efficient way to fetch and manage client-side data in your Next.js applications. SWR stands for Stale-While-Revalidate, a strategy that serves cached data while simultaneously fetching updated data, ensuring your app has fast and up-to-date data without unnecessary network calls.

The Philosophy behind SWR

The core philosophy of SWR revolves around the Stale-While-Revalidate concept. This means that when data is requested, SWR first returns the cached data (stale) while it revalidates in the background to fetch the latest data. This approach significantly enhances the user experience by reducing load times and ensuring that users see the most current information without delay. This method aligns with the HTTP cache invalidation strategy popularized by RFC 586.

Overview of Key Features

SWR offers a multitude of features that make it an excellent choice for data fetching in client-side applications:

1. Automatic Caching and Revalidation: SWR caches data on the client side and automatically revalidates it, ensuring the app always displays the latest data. This mechanism helps prevent unnecessary request calls and reduces the server load.

2. Focus Tracking and Re-fetching: The library tracks when the user returns to a page and automatically re-fetches data to ensure accuracy, enhancing the reliability of displayed information.

3. Support for Multiple Data Sources: You can use any data-fetching library such as fetch, Axios, or even GraphQL, making it highly flexible and adaptable to various backend services.

4. Easy Error Handling and Data Prefetching: SWR provides built-in mechanisms for error handling and allows for data prefetching, which can be particularly useful in optimizing the user experience and ensuring smooth navigation across different parts of your app.

5. Infinite Loading and Pagination: The library supports advanced features like infinite loading, which is crucial for applications dealing with large datasets that need to be loaded progressively.

6. Global Configuration and Mutations: SWR allows global configuration settings and provides mutation APIs to manually update cached data, offering a high degree of control over data management.

SWR Fundamentals

Understanding the SWR Hook

The useSWR hook is the cornerstone of the SWR library. It simplifies data fetching in React applications by providing a declarative way to manage the loading, error, and data states. To start using the useSWR hook, you need to import it into your component. The useSWR hook accepts three parameters: a key (usually the API endpoint), a fetcher function, and an optional object of options that provides flexibility in handling the data. The useSWR hook returns an object containing several properties, including data, error, and isLoading.

Here’s a basic example of how to use useSWR: import useSWR from 'swr';

In this example, useSWR accepts the URL /api/user as the key and the fetcher function. It returns data when the request is successful, handles errors, and shows a loading state while the data is being fetched.

Fetcher Functions Explained

A fetcher function is a critical part of using SWR. This function is responsible for fetching the data from a given source. It is an asynchronous function that returns the data you need. You can define the fetcher function according to the data source you're working with, whether it’s a REST API, GraphQL, or any other service.

For example, using the native fetch API, a simple fetcher function might look like this:

This function takes any number of arguments (...args), passes them to fetch, and then parses the response as JSON. If you're using a different library like Axios, the fetcher function would look slightly different:

In this case, the fetcher uses Axios to fetch data from the given URL and returns the response data.

SWR Configuration Details

SWR offers extensive configuration options to customize its behavior globally or locally within a component. The SWRConfig component is used to set global configuration, while individual hooks can also accept configuration options.

Global Configuration

To apply global configurations, you wrap your application with the SWRConfig component:

In the above example, the global configuration sets a default fetcher function that all useSWR hooks will use unless overridden locally.

Local Configuration

You can also configure SWR locally by passing an options object as the third parameter to useSWR:

In this example, the data will refresh every 3000 milliseconds, and the onErrorRetry callback function will handle retries, limiting them to 10 attempts with a 5-second delay between retries.

Data Fetching Patterns in SWR

Basic Data Loading

Basic data loading with SWR, especially when fetching client-side data, is straightforward and efficient. You start by importing the useSWR hook and defining a fetcher function. The fetcher function is used to retrieve data from an API endpoint.

Here’s a simple example:

In this example, useSWR is used to fetch data from /api/user. The fetcher function retrieves and parses the JSON data. The hook returns data, error, and isLoading states to handle the different stages of the data fetching process.

Advanced Data Fetching Options

SWR provides several advanced options to enhance your data fetching capabilities:

1. Conditional Fetching: Fetch data only when certain conditions are met. This can be useful for fetching data based on user interactions or specific state changes.

2. Dependent Fetching: Fetch data based on the results of another fetch. This can be useful for fetching related resources sequentially.

3. Pagination: Implement pagination to fetch data in chunks. SWR can manage page states and fetch data accordingly.

4. Re-fetching on Interval: Automatically re-fetch data at specified intervals to keep it up-to-date.

These advanced options make SWR a versatile tool for handling various data fetching scenarios, ensuring your application remains responsive and efficient.

Handling Data Revalidation

Data revalidation is a core feature of SWR, ensuring that your application always displays the most accurate and up-to-date data. SWR supports several revalidation strategies:

1. Focus Revalidation: Re-fetch data when the window gains focus. This is useful for applications that might be idle for some time and need to update data when the user returns.

2. Network Recovery: Re-fetch data when the network connection is restored after being lost.

3. Manual Revalidation: Manually trigger a revalidation using the mutate function. This can be useful after performing an action that changes the data, such as a form submission.

4. Interval Revalidation: Periodically re-fetch data at a specified interval.

By using these revalidation strategies, SWR helps maintain data integrity and ensures your application reflects the latest data changes efficiently.

Client Side Data Management with SWR

Caching Strategies for Fast Data Retrieval

One of the key strengths of SWR is its built-in caching mechanism that ensures fast data retrieval. SWR caches data on the client side, which significantly reduces the number of network requests and speeds up data access.

1. Default Cache: By default, SWR uses a global cache shared across all useSWR hooks. This cache stores fetched data and reuses it whenever possible, reducing redundant network requests.

2. Custom Cache Providers: You can customize the cache provider to use more persistent storage solutions like localStorage or IndexedDB. This can be useful for storing larger amounts of data or for retaining data across page reloads.

3. Manual Cache Management: SWR provides the mutate function to manually update the cache. This is useful when you need to optimistically update the UI after a mutation.

Real-Time Data with SWR

SWR supports client-side data fetching, which is crucial for applications that require continuously updated information. Here are some strategies to achieve real-time data with SWR:

1. Polling: You can set the refreshInterval option to periodically re-fetch data. This keeps the data fresh and up-to-date.

2. Focus and Reconnect: SWR automatically re-fetches data when the window gains focus or the network connection is restored. This ensures that users always see the latest data after returning to the application or recovering from a network interruption.

3. WebSockets and Subscriptions: For more sophisticated real-time updates, you can use WebSockets or other subscription-based methods alongside SWR. While SWR handles the initial data fetching and caching, WebSockets can push updates to the client in real-time.

Reusable and Immutable Data Techniques

SWR promotes the creation of reusable data fetching hooks, which enhance code maintainability and readability. Additionally, SWR supports immutable data practices to prevent accidental modifications.

1. Reusable Data Fetching Hooks: You can encapsulate data fetching logic into custom hooks, making it easy to reuse across different components.

2. Immutable Data: SWR encourages the use of immutable data structures. By treating data as immutable, you avoid unintended side effects and ensure that updates are predictable and manageable.

Optimizing Performance and UX

Preventing Unnecessary Network Calls

To optimize performance in your Next.js application using SWR, it's crucial to prevent unnecessary network calls. This not only improves the user experience but also reduces server load and bandwidth usage.

1. Conditional Fetching: Fetch data only when necessary by using conditional fetching. This technique ensures that requests are made only when certain conditions are met.

2. Request Deduplication: SWR automatically deduplicates requests for the same key within a short time frame. This prevents multiple components from making redundant requests.

3. Focus and Reconnect: By default, SWR revalidates data when the window gains focus or the network connection is restored. You can customize or disable this behavior to reduce network calls.

4. Debouncing and Throttling: Implement debouncing or throttling for user input that triggers data fetching. This ensures that data is fetched only after the user has stopped typing or after a certain interval.

5. Local Mutation: Use SWR’s mutate function to update the cache manually when you know the data has changed, avoiding an immediate network request.

Infinite Loading UI with SWR

Implementing an infinite loading UI with SWR is straightforward, especially with the useSWRInfinite hook, which is designed for handling paginated data.

1. Basic Setup: Define a key-generating function and a fetcher function for paginated data.

2. Handling Edge Cases: Manage scenarios where there is no more data to fetch or when an error occurs. Use conditional rendering to provide feedback to the user.

Performance Tips

Ensuring that your application performs well across different devices and network conditions is essential for a good user experience. Here are some tips to enhance responsive UI performance using SWR:

1. Lazy Loading: Load data or components only when they are needed. This reduces the initial load time and ensures faster rendering of critical components.

2. Code Splitting: Use dynamic imports to split your code into smaller bundles that are loaded on demand.

3. Optimized Images: Use Next.js's built-in Image component to serve optimized images, reducing load times and improving performance.

4. Network-Condition-Based Fetching: Adapt your data fetching strategy based on the user’s network condition. For example, reduce the frequency of polling or the amount of data fetched on slower networks.

Error Handling and Data Prefetching

Strategies for Error Handling in SWR

Effective error handling is crucial for a robust data fetching strategy. SWR provides built-in support for handling errors, making it easier to manage and display error states in your application.

1. Default Error Handling: SWR automatically captures errors and exposes them via the error property returned by the useSWR hook. You can use this property to display error messages or take other actions.

2. Custom Error Handling: For more complex error handling, you can use SWR's configuration options to define custom error handling logic. This can include retry mechanisms, logging, or user notifications.

3. Retry Logic: Implement retry logic for handling transient errors. SWR allows you to configure retry behavior using the onErrorRetry option.

Implementing Data Prefetching

Data prefetching is a powerful technique to improve the user experience by loading data before it is needed. This can make navigation between pages smoother and faster.

1. Static Generation with Prefetching: Use Next.js's getStaticProps to prefetch data at build time. This is particularly useful for pages that don't change frequently.

2. Client-Side Prefetching: Prefetch data on the client side using the mutate function to prime the cache before a user navigates to a new page.

Custom Error Handling Callbacks

Custom error handling callbacks provide fine-grained control over how errors are managed in your application. These callbacks can be used for logging, user notifications, and implementing custom retry strategies.

1. onError Callback: The onError callback allows you to handle errors globally or on a per-request basis.

2. onErrorRetry Callback: Use the onErrorRetry callback to implement custom retry logic, including exponential backoff and limiting the number of retries.

Conclusion

In conclusion, leveraging Next.js SWR in your applications can significantly enhance data fetching, performance, and user experience. By understanding the fundamentals of SWR, including the useSWR hook, fetcher functions, and configuration options, you can implement efficient data management strategies.

Advanced data fetching patterns, such as conditional fetching, pagination, and real-time updates, along with robust error handling and data prefetching techniques, ensure that your applications remain responsive and reliable. Embracing these practices will help you build scalable and maintainable applications with a seamless user experience.

import useSWR from 'swr';

const fetcher = (url) => fetch(url).then((res) => res.json());

function Profile() {
  const { data, error } = useSWR('/api/user', fetcher);

  if (error) return <div>Failed to load</div>;
  if (!data) return <div>Loading...</div>;
  return <div>Hello, {data.name}!</div>;
}

const fetcher = (...args) => fetch(...args).then(res => res.json());

import axios from 'axios';

const fetcher = (url) => axios.get(url).then((res) => res.data);

import { SWRConfig } from 'swr';

function MyApp({ Component, pageProps }) {
  return (
    <SWRConfig value={{ fetcher }}>
      <Component {...pageProps} />
    </SWRConfig>
  );
}

const { data, error } = useSWR('/api/user', fetcher, {
  refreshInterval: 3000,
  onErrorRetry: (error, key, config, revalidate, { retryCount }) => {
    if (retryCount >= 10) return;
    setTimeout(() => revalidate({ retryCount }), 5000);
  }
});

import useSWR from 'swr';

const fetcher = (url) => fetch(url).then((res) => res.json());

function UserProfile() {
  const { data, error, isLoading } = useSWR('/api/user', fetcher);

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error loading data</div>;
  return <div>Hello, {data.name}!</div>;
}

const shouldFetch = true;
const { data, error } = useSWR(shouldFetch ? '/api/data' : null, fetcher);

const { data: user } = useSWR('/api/user', fetcher);
const { data: profile } = useSWR(() => user ? `/api/profile/${user.id}` : null, fetcher);

const { data, error, size, setSize } = useSWRInfinite(
  (index) => `/api/data?page=${index + 1}`,
  fetcher
);

const loadMore = () => setSize(size + 1);

const { data, error } = useSWR('/api/data', fetcher, { refreshInterval: 5000 });

const { data, error } = useSWR('/api/data', fetcher, { revalidateOnFocus: true });

const { data, error } = useSWR('/api/data', fetcher, { revalidateOnReconnect: true });

import { mutate } from 'swr';

const handleSubmit = async () => {
  await fetch('/api/update', { method: 'POST', body: JSON.stringify(newData) });
  mutate('/api/data');
};

const { data, error } = useSWR('/api/data', fetcher, { refreshInterval: 3000 });

import { SWRConfig } from 'swr';

function App() {
  return (
    <SWRConfig value={{ provider: () => new Map() }}>
      <MyComponent />
    </SWRConfig>
  );
}

import { mutate } from 'swr';

const handleUpdate = async () => {
  const updatedData = { ...data, name: 'New Name' };
  mutate('/api/user', updatedData, false); // Update local cache without revalidation
};

const { data, error } = useSWR('/api/data', fetcher, { refreshInterval: 5000 });

const { data, error } = useSWR('/api/data', fetcher, {
  revalidateOnFocus: true,
  revalidateOnReconnect: true,
});

useEffect(() => {
  const socket = new WebSocket('wss://example.com/socket');

  socket.onmessage = (event) => {
    const newData = JSON.parse(event.data);
    mutate('/api/data', newData, false); // Update local cache without revalidation
  };

  return () => socket.close();
}, []);

function useUser(id) {
  const { data, error, isLoading } = useSWR(`/api/user/${id}`, fetcher);
  return { data, error, isLoading };
}

function UserProfile({ id }) {
  const { data, error, isLoading } = useUser(id);

  if (isLoading) return <div>Loading...</div>;
  if (error) return <div>Error loading data</div>;
  return <div>Hello, {data.name}!</div>;
}

const handleUpdate = async () => {
  const updatedData = { ...data, name: 'New Name' };
  mutate('/api/user', updatedData, false); // SWR ensures the updated data is treated as a new object
};

const shouldFetch = userId !== null;
const { data, error } = useSWR(shouldFetch ? `/api/user/${userId}` : null, fetcher);

const { data, error } = useSWR('/api/data', fetcher, {
  revalidateOnFocus: false,
  revalidateOnReconnect: false,
});

const handleChange = debounce((value) => {
  mutate(`/api/search?query=${value}`);
}, 300);

const handleSave = async (newData) => {
  await fetch('/api/save', { method: 'POST', body: JSON.stringify(newData) });
  mutate('/api/data', newData, false); // Update the cache without revalidation
};

import useSWRInfinite from 'swr/infinite';

const getKey = (pageIndex, previousPageData) => {
  if (previousPageData && !previousPageData.length) return null; // Reached the end
  return `/api/data?page=${pageIndex + 1}`; // SWR key
};

const fetcher = (url) => fetch(url).then((res) => res.json());

function InfiniteScroll() {
  const { data, error, size, setSize } = useSWRInfinite(getKey, fetcher);

  if (error) return <div>Error loading data</div>;
  if (!data) return <div>Loading...</div>;

  return (
    <div>
      {data.map((page, index) => (
        <div key={index}>
          {page.map(item => (
            <div key={item.id}>{item.name}</div>
          ))}
        </div>
      ))}
      <button onClick={() => setSize(size + 1)}>Load more</button>
    </div>
  );
}

const { data, error, size, setSize, isValidating } = useSWRInfinite(getKey, fetcher);

if (error) return <div>Error loading data</div>;
if (!data) return <div>Loading...</div>;

return (
  <div>
    {data.map((page, index) => (
      <div key={index}>
        {page.map(item => (
          <div key={item.id}>{item.name}</div>
        ))}
      </div>
    ))}
    {isValidating && <div>Loading more...</div>}
    <button onClick={() => setSize(size + 1)}>Load more</button>
  </div>
);

const LazyComponent = React.lazy(() => import('./LazyComponent'));

function App() {
  return (
    <Suspense fallback={<div>Loading...</div>}>
      <LazyComponent />
    </Suspense>
  );
}

import dynamic from 'next/dynamic';

const DynamicComponent = dynamic(() => import('./DynamicComponent'), { ssr: false });

function App() {
  return <DynamicComponent />;
}

import Image from 'next/image';

function UserProfile({ user }) {
  return <Image src={user.profilePicture} alt="Profile Picture" width={500} height={500} />;
}

const isSlowNetwork = navigator.connection.downlink < 1.5;

const { data, error } = useSWR('/api/data', fetcher, {
  refreshInterval: isSlowNetwork ? 10000 : 3000,
});

const { data, error, isLoading } = useSWR('/api/user', fetcher);

if (isLoading) return <div>Loading...</div>;
if (error) return <div>Error loading data</div>;
return <div>Hello, {data.name}!</div>;

const { data, error } = useSWR('/api/user', fetcher, {
  onError: (err) => {
    console.error('Error fetching data:', err);
    alert('Failed to load user data');
  },
});

const { data, error } = useSWR('/api/user', fetcher, {
  onErrorRetry: (error, key, config, revalidate, { retryCount }) => {
    if (retryCount >= 3) return; // Stop retrying after 3 attempts
    setTimeout(() => revalidate({ retryCount }), 5000); // Retry after 5 seconds
  },
});

export async function getStaticProps() {
  const data = await fetcher('/api/data');
  return { props: { fallback: { '/api/data': data } } };
}

function Page({ fallback }) {
  return (
    <SWRConfig value={{ fallback }}>
      <Component />
    </SWRConfig>
  );
}

import { mutate } from 'swr';

const prefetchData = async () => {
  const data = await fetcher('/api/data');
  mutate('/api/data', data, false); // Prefetch and update cache without revalidation
};

useEffect(() => {
  prefetchData();
}, []);

const { data, error } = useSWR('/api/user', fetcher, {
  onError: (error) => {
    console.error('An error occurred:', error);
    alert('Failed to load data. Please try again.');
  },
});

const { data, error } = useSWR('/api/user', fetcher, {
  onErrorRetry: (error, key, config, revalidate, { retryCount }) => {
    if (retryCount >= 5) return; // Stop retrying after 5 attempts
    const timeout = Math.min(1000 * 2 ** retryCount, 30000); // Exponential backoff
    setTimeout(() => revalidate({ retryCount }), timeout);
  },
});