Skip to main content
On this page

JSX

View Page as MarkdownOpen the Markdown file in a new tabOpen in ClaudeAsk Claude about this page

Deno 内置支持 .jsx 文件和 .tsx 文件中的 JSX。Deno 中的 JSX 对于服务器端渲染或为浏览器生成代码非常有用。

默认配置 Jump to heading

Deno CLI 对 JSX 有默认配置，这与 tsc 的默认配置不同。实际上，Deno 默认使用以下 TypeScript 编译器 选项：

deno.json
{
  "compilerOptions": {
    "jsx": "react",
    "jsxFactory": "React.createElement",
    "jsxFragmentFactory": "React.Fragment"
  }
}

Note

当使用带有 React 的默认 "react" 模式时，你需要添加 @types/react 才能进行类型检查（例如，在你的 deno.json 导入中加入 "@types/react": "npm:@types/react"）。不添加的话你会遇到类似 JSX 元素隐式具有 'any' 类型 之类的错误。考虑改用 自动运行时，这是推荐的做法。

使用 "react" 选项会将 JSX 转换为如下的 JavaScript 代码：

// 输入
const jsx = (
  <div className="foo">
    <MyComponent value={2} />
  </div>
);

// 输出:
const jsx = React.createElement(
  "div",
  { className: "foo" },
  React.createElement(MyComponent, { value: 2 }),
);

JSX 自动运行时（推荐） Jump to heading

在 React 17 中，React 团队添加了他们所称之为 新的 JSX 转换。这增强了 JSX 转换的 API，并提供了一种机制，可以自动添加相关的 JSX 导入，从而你无需手动添加。这是推荐使用 JSX 的方式。

要使用更新的 JSX 运行时转换，请在你的 deno.json 中更改编译器选项。

deno.json
{
  "compilerOptions": {
    "jsx": "react-jsx",
    "jsxImportSource": "react"
  },
  "imports": {
    "react": "npm:react",
    "@types/react": "npm:@types/react"
  }
}

install dependencies

当你手动向 deno.json 文件添加导入时，请记得运行 deno install 来下载安装并缓存依赖。

幕后 jsxImportSource 设置总是会向导入说明符追加一个 /jsx-runtime。

// 此导入将被自动插入
import { jsx as _jsx } from "react/jsx-runtime";

使用 "react-jsx" 选项将 JSX 转换为以下 JavaScript 代码：

// 输入
const jsx = (
  <div className="foo">
    <MyComponent value={2} />
  </div>
);

// 输出
import { jsx as _jsx } from "react/jsx-runtime";
const jsx = _jsx(
  "div",
  {
    className: "foo",
    children: _jsx(MyComponent, { value: 2 }),
  },
);

如果你希望使用 Preact 而不是 React，你可以相应地更新 jsxImportSource 的值。

deno.json
  {
    "compilerOptions": {
      "jsx": "react-jsx",
-     "jsxImportSource": "react"
+     "jsxImportSource": "preact"
    },
    "imports": {
-     "react": "npm:react"
+     "preact": "npm:preact"
    }
  }

开发转换 Jump to heading

将 "jsx" 选项设置为 "react-jsxdev" 而不是 "react-jsx"，将为每个 JSX 节点传递额外的调试信息。额外的信息包括每个 JSX 节点调用位置的文件路径、行号和列号。

这些信息通常在框架中用于增强开发期间的调试体验。在 React 中，这些信息用于增强堆栈跟踪，并显示组件在哪个位置被实例化，通常在 React 开发者工具的浏览器扩展中显示。

使用 "react-jsxdev" 选项将 JSX 转换为以下 JavaScript 代码：

// 输入
const jsx = (
  <div className="foo">
    <MyComponent value={2} />
  </div>
);

// 输出
import { jsxDEV as _jsxDEV } from "react/jsx-dev-runtime";
const _jsxFileName = "file:///input.tsx";
const jsx = _jsxDEV(
  "div",
  {
    className: "foo",
    children: _jsxDEV(
      MyComponent,
      {
        value: 2,
      },
      void 0,
      false,
      {
        fileName: _jsxFileName,
        lineNumber: 3,
        columnNumber: 5,
      },
      this,
    ),
  },
  void 0,
  false,
  {
    fileName: _jsxFileName,
    lineNumber: 1,
    columnNumber: 14,
  },
  this,
);

Caution

仅在开发期间使用 "react-jsxdev"，不要在生产环境中使用。

使用 JSX 导入源谚语 Jump to heading

无论你的项目是否为 JSX 配置了导入源，还是使用默认的“旧版”配置，你都可以在 .jsx 或 .tsx 模块中添加 JSX 导入源谚语，并且 Deno 会尊重它。

@jsxImportSource 谚语需要位于模块开头的注释中。例如，要使用来自 esm.sh 的 Preact，你可以这样做：

/** @jsxImportSource https://esm.sh/preact */

export function App() {
  return (
    <div>
      <h1>Hello, world!</h1>
    </div>
  );
}

jsxImportSourceTypes Jump to heading

在某些情况下，库可能不提供类型。要指定类型，你可以使用 @jsxImportSourceTypes 谚语：

/** @jsxImportSource npm:react@^18.3 */
/** @jsxImportSourceTypes npm:@types/react@^18.3 */

export function Hello() {
  return <div>Hello!</div>;
}

或者通过在 deno.json 中使用 jsxImportSourceTypes 编译器选项来指定：

deno.json
{
  "compilerOptions": {
    "jsx": "react-jsx",
    "jsxImportSource": "npm:react@^18.3",
    "jsxImportSourceTypes": "npm:@types/react@^18.3"
  }
}

JSX 预编译转换 Jump to heading

Deno 附带了一种 新的 JSX 转换，其针对服务器端渲染进行了优化。与其他 JSX 转换选项相比，它可能快 7-20 倍。区别在于，预编译转换会对你的 JSX 进行静态分析，并在可能的情况下存储预编译的 HTML 字符串。这可以避免在创建 JSX 对象时消耗大量时间。

要使用预编译转换，请将 jsx 选项设置为 "precompile"。

deno.json
  {
    "compilerOptions": {
+     "jsx": "precompile",
      "jsxImportSource": "preact"
    },
    "imports": {
      "preact": "npm:preact"
    }
  }

为了防止代表 HTML 元素的 JSX 节点被预编译，你可以将它们添加到 jsxPrecompileSkipElements 设置中。

deno.json
  {
    "compilerOptions": {
      "jsx": "precompile",
      "jsxImportSource": "preact",
+     "jsxPrecompileSkipElements": ["a", "link"]
    },
    "imports": {
      "preact": "npm:preact"
    }
  }

Note

precompile 转换与 Preact 或 Hono 最为兼容。它在 React 中不支持。

使用 "precompile" 选项将 JSX 转换为以下 JavaScript 代码：

// 输入
const jsx = (
  <div className="foo">
    <MyComponent value={2} />
  </div>
);

// 输出:
import {
  jsx as _jsx,
  jsxTemplate as _jsxTemplate,
} from "npm:preact/jsx-runtime";
const $$_tpl_1 = [
  '<div class="foo">',
  "</div>",
];
function MyComponent() {
  return null;
}
const jsx = _jsxTemplate(
  $$_tpl_1,
  _jsx(MyComponent, {
    value: 2,
  }),
);

在服务器响应中渲染 JSX Jump to heading

在 Deno 中使用 JSX 进行服务器端渲染时，你需要将 JSX 组件转换为可以在响应中发送的 HTML 字符串。这在使用 Deno.serve 构建 Web 应用程序时特别有用。

使用 Preact 和 renderToString Jump to heading

对于 Preact 应用程序，你可以使用 preact-render-to-string 包：

deno.json
{
  "compilerOptions": {
    "jsx": "precompile",
    "jsxImportSource": "preact"
  },
  "imports": {
    "preact": "npm:preact@^10.26.6",
    "preact-render-to-string": "npm:preact-render-to-string@^6.5.13"
  }
}

然后在你的服务器代码中：

server.tsx
import { renderToString } from "preact-render-to-string";

const App = () => {
  return <h1>Hello world</h1>;
};

Deno.serve(() => {
  const html = `<!DOCTYPE html>${renderToString(<App />)}`;
  return new Response(html, {
    headers: { "Content-Type": "text/html; charset=utf-8" },
  });
});

这种方法与预编译转换配合良好，提供了最佳的服务器端渲染性能。

使用 React 的 renderToString Jump to heading

如果你使用 React 而不是 Preact，可以使用 React 自身的服务器渲染能力：

deno.json
{
  "compilerOptions": {
    "jsx": "react-jsx",
    "jsxImportSource": "react"
  },
  "imports": {
    "react": "npm:react@^18.2.0",
    "react-dom": "npm:react-dom@^18.2.0",
    "react-dom/server": "npm:react-dom@^18.2.0/server"
  }
}

在你的服务器代码中：

server.tsx
import { renderToString } from "react-dom/server";

const App = () => {
  return <h1>Hello from React</h1>;
};

Deno.serve(() => {
  const html = `<!DOCTYPE html>${renderToString(<App />)}`;
  return new Response(html, {
    headers: { "Content-Type": "text/html; charset=utf-8" },
  });
});

使用这些配置，你的 Deno 服务器可以高效地将 JSX 组件渲染为 HTML 并将其提供给客户端。

Last updated on

你找到了你需要的东西吗？

编辑此页面
隐私政策