spring boot 统计内存占用

原创

mob649e8163af7d 2024-08-12 04:11:42 ©著作权

文章标签 java spring REST 文章分类 spring boot 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e8163af7d的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用 Spring Boot 统计内存占用的指南

在现代应用程序中，监控和优化内存使用是至关重要的，尤其是使用 Spring Boot 开发的应用程序。本文将带领你完成一个实现内存占用统计的过程。我们将会使用 Java 的 ManagementFactory 和 MemoryMXBean 来获取内存占用的信息。

整体流程

下面我们列出实现这项功能的主要步骤：

步骤	描述
1	创建 Spring Boot 项目
2	添加监控内存的服务类
3	创建 REST 接口来展示数据
4	启动并测试 Spring Boot 应用

步骤 1: 创建 Spring Boot 项目

首先，你可以通过 Spring Initializr（ Spring Boot 项目。选择相应的项目配置，建议使用 Maven 作为构建工具。确保选择 Spring Web 依赖。

你可以使用命令行创建项目：

curl  -d dependencies=web -d name=MemoryUsageDemo -d packageName=com.example.memoryusagedemo -o memoryusagedemo.zip
unzip memoryusagedemo.zip

步骤 2: 添加监控内存的服务类

创建一个新的 Java 类，用来处理内存占用监控的逻辑。我们将使用 MemoryMXBean。

package com.example.memoryusagedemo.service;

import org.springframework.stereotype.Service;

import java.lang.management.ManagementFactory;
import java.lang.management.MemoryMXBean;
import java.lang.management.MemoryUsage;

@Service
public class MemoryUsageService {

    // 获取 MemoryMXBean 实例
    private final MemoryMXBean memoryMXBean = ManagementFactory.getMemoryMXBean();

    public String getMemoryUsage() {
        // 获取堆内存使用情况
        MemoryUsage heapMemoryUsage = memoryMXBean.getHeapMemoryUsage();
        // 获取非堆内存使用情况
        MemoryUsage nonHeapMemoryUsage = memoryMXBean.getNonHeapMemoryUsage();

        // 格式化输出内存占用信息
        return String.format("Heap Memory: used = %d bytes, committed = %d bytes, max = %d bytes; Non-Heap Memory: used = %d bytes, committed = %d bytes, max = %d bytes.",
                heapMemoryUsage.getUsed(), heapMemoryUsage.getCommitted(), heapMemoryUsage.getMax(),
                nonHeapMemoryUsage.getUsed(), nonHeapMemoryUsage.getCommitted(), nonHeapMemoryUsage.getMax());
    }
}

以上代码的注释说明：

MemoryMXBean 是用于获取 Java 虚拟机（JVM）内存管理的信息。
getMemoryUsage 方法获取当前的堆和非堆内存的使用情况，并格式化为一个字符串。

步骤 3: 创建 REST 接口来展示数据

现在，你需要创建一个 REST 控制器，将内存使用信息暴露为 API。

package com.example.memoryusagedemo.controller;

import com.example.memoryusagedemo.service.MemoryUsageService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class MemoryUsageController {

    @Autowired
    private MemoryUsageService memoryUsageService;

    // 创建一个 GET 请求的接口，返回内存使用信息
    @GetMapping("/memory-usage")
    public String getMemoryUsage() {
        return memoryUsageService.getMemoryUsage();
    }
}

以上代码的注释说明：