# mx-http-server

**Repository Path**: xjpVips/mx-http-server

## Basic Information

- **Project Name**: mx-http-server
- **Description**: httpserver插件
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-07-24
- **Last Updated**: 2026-07-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README



# mx-http-server

一个 IntelliJ IDEA 插件，用于在 IDE 中快速启动 HTTP 服务器来预览静态文件。

## 功能特性

- **内置 HTTP 服务器**：使用 Java 内置的 `HttpServer` 实现，无需额外依赖
- **外部服务器支持**：可配置使用外部 HTTP 服务器（如 nginx、http-server 等）
- **图形化配置**：通过 IDE 运行配置界面设置服务器参数
- **实时日志输出**：在 IDE 的运行窗口中显示服务器日志和访问地址

## 快速开始

### 环境要求

- IntelliJ IDEA 2021.1 或更高版本
- JDK 11 或更高版本

### 安装方法

1. 从 [Gitee Releases](https://gitee.com/xjpVips/mx-http-server/releases) 下载最新版本的插件 JAR 文件
2. 打开 IntelliJ IDEA，进入 `Settings/Preferences` → `Plugins`
3. 点击设置图标，选择 `Install Plugin from Disk...`
4. 选择下载的 JAR 文件并重启 IDE

### 使用方法

1. 打开 `Run` → `Edit Configurations...`
2. 点击 `+` 添加配置，选择 `Http Server`
3. 配置以下参数：
   - **Directory**：指定静态文件目录
   - **Port**：服务器端口号（默认 8080）
   - **Engine Type**：选择服务器引擎（内置/外部）
   - **External Command**：外部服务器命令（仅外部引擎需要）
4. 点击 `OK` 保存配置
5. 点击运行按钮启动服务器

## 项目结构

```
src/main/java/com/mx/plugin/httpserver/
├── config/
│   └── ServerConfig.java          # 服务器配置实体类
├── icons/
│   └── HttpServerIcons.java       # 插件图标接口
├── runconfig/
│   ├── HttpServerConfigurationType.java  # 运行配置类型
│   ├── HttpServerRunConfiguration.java   # 运行配置类
│   ├── HttpServerRunProfileState.java    # 运行状态类
│   ├── HttpServerProcessHandler.java     # 进程处理器
│   └── HttpServerSettingsEditor.java     # 配置编辑器UI
└── server/
    ├── ServerEngine.java          # 服务器引擎接口
    ├── ServerManager.java         # 服务器管理器
    ├── InternalHttpServer.java    # 内置HTTP服务器实现
    └── ExternalHttpServer.java    # 外部HTTP服务器实现
```

## 配置说明

### ServerConfig 配置项

| 属性 | 类型 | 说明 |
|------|------|------|
| name | String | 配置名称 |
| directory | String | 服务根目录 |
| port | int | 监听端口 |
| engineType | String | 引擎类型（internal/external） |
| externalCommand | String | 外部服务器启动命令 |

### 内置服务器特性

- 支持静态文件 MIME 类型自动识别
- 支持目录浏览
- 自动获取本地 IP 地址

## 开发构建

### 环境准备

```bash
# 克隆项目
git clone https://gitee.com/xjpVips/mx-http-server.git
cd mx-http-server
```

### 构建命令

```bash
# 使用 Gradle 构建
./gradlew build

# 打包插件
./gradlew buildPlugin
```

### 运行调试

```bash
# 在沙箱 IDEA 中运行插件
./gradlew runIde
```

## 许可证

本项目基于 [MIT License](LICENSE) 开源。

## 贡献指南

1. Fork 本项目
2. 创建功能分支 (`git checkout -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add amazing feature'`)
4. 推送到分支 (`git push origin feature/amazing-feature`)
5. 发起 Pull Request