Skip to main content

Command Palette

Search for a command to run...

如何通过互联网访问本地Spring Boot程序

Updated
如何通过互联网访问本地Spring Boot程序

当你需要别人远程访问你本地的Spring Boot的程序的时候,你可以通过Ngrok来帮助你来实现。

什么是Ngrok

Ngrok可以创建一个http隧道,并为您提供一个公共URL,重定向到本地机器上的指定端口。它是一个很棒的开发或者测试目的使用的工具。

Ngrok的官网地址是:https://ngrok.com

image.png

Ngrok Spring Boot Starter

Spring Boot的Web端口可以通过Ngrok Spring Boot Starter暴露到互联网。

Ngrok Spring Boot Starter将会根据你的操作系统自动下载Ngrok的二进制文件并缓存到home_directory/.ngrok2 目录。

每次运行Spring Boot程序的时候,Ngrok会自动构建指向Spring Boot Web程序的http隧道。

该Starter的地址为:https://github.com/kilmajster/ngrok-spring-boot-starter

注册Ngrok

  • 注册Ngrok 访问Ngrok官网:https://ngrok.com/,注册Ngrok账号

  • 获取Ngrok的认证码 访问: https://dashboard.ngrok.com/get-started/your-authtoken ,即可看到authtoken。

image.png

Spring Boot 代码演示

  • 新建演示项目

image.png

  • 简单的演示代码
@SpringBootApplication
@RestController
public class NgrokDemoApplication {

   public static void main(String[] args) {
      SpringApplication.run(NgrokDemoApplication.class, args);
   }

   @GetMapping("/")
   public String index(){
      return "Hello Ngrok!";
   }

}
  • 添加ngrok-spring-boot-starter依赖

Gradle:

implementation 'io.github.kilmajster:ngrok-spring-boot-starter:0.6.0'

或Maven:

<dependency>
  <groupId>io.github.kilmajster</groupId>
  <artifactId>ngrok-spring-boot-starter</artifactId>
  <version>0.6.0</version>
</dependency>
  • 简单配置 在application.yaml 中:
ngrok:
  enabled: true # 开启ngrok
  auth-token:  ------# 复制上面获取的authtoken到此处
  • 启动程序

image.png

通过Spring Boot控制台,你可以发现:

  1. 启动时程序自动会自动下载ngrok并解压缓存到系统用户的.ngrok下。
  2. 启动ngrok,ngrok dashboard的地址是:http://127.0.0.1:4040
  • 访问ngrok dashboard

image.png

你会发现ngrok为我们提供了两个公网访问的地址,分别是http和https的。

  • 访问ngrok提供的公网地址

image.png

image.png

用手机访问:

image.png

ping 域名返回的也是公网的ip:

image.png

更多关于如何使用的,请参考Starter的项目地址。

感谢支持我的书:《从企业级开发到云原生微服务:Spring Boot实战》

头条文章地址:https://www.toutiao.com/article/7080505822463214093/

参考资料: https://github.com/kilmajster/ngrok-spring-boot-starter

More from this blog

用Java 17的Records加速Spring Boot开发

在《Spring Boot 2.6新特性:使用Java 17的Record作为配置属性》,我们提到了使用Java Records来作为Spring Boot的配置属性(configuration properties),从而减少了大量样板代码的编写,我们本篇将进一步拓展Records在Spring Boot下的应用场景,从而进一步减少我们的样板代码,使代码看上去更简洁清晰。 1、什么是Records record是一种特殊类型的类声明,目的是为了减少样板代码。record引入的主要目的是快速创...

Nov 11, 2022
用Java 17的Records加速Spring Boot开发

Spring Boot 2.6新特性:使用Java 17的Record作为配置属性

Spring Boot 3.0的基线版本是Java 17,Spring Boot 3.0版本将全面对Java 17的支持。较新版本的2.x的Spring Boot版本也可以使用Java 17的特性。 本文介绍Spring Boot 2.6对Java 17支持的一个新特性,使用Java 17的Record来做为Spring Boot的配置属性(ConfiguartionProperties)。 什么是Record record是一种特殊类型的类声明,目的是为了减少样板代码。record引入的主要目...

Nov 3, 2022
Spring Boot 2.6新特性:使用Java 17的Record作为配置属性

使用Gradle全面加速Spring Boot开发

大家都知道Gradle和Maven一样,是一个项目的构建工具。它通过任务来控制开发的进程,这些任务包括:编译、打包、测试、部署和发布等。Gradle诞生于2008年,仅仅比Maven晚4年。Android也采用Gradle作为默认的构建工具。 本文期望通过以下的讲述,帮助你快速轻松的使用Gradle加速您的Spring Boot开发应用。 1、Gradle越来越流行 2012年开始,Spring框架已全部使用Gradle来构建;2020年开始,Spring Boot也全部采用Gradle来构建...

Oct 31, 2022
使用Gradle全面加速Spring Boot开发

Spring/Spring Boot下如何动态配置计划任务

在Spring/Spring Boot下实现计划任务是很简单的,我们只需通过@EnableScheduling 开启计划任务的支持,然后通过@Scheduled 注解来制定计划任务,这样的实现解决了我们对计划任务的绝大部分需求。 但在很多时候,通过上述方式实现的计划任务是在代码里写死的,我们需要修改计划任务只能通过修改代码的方式实现。很多时候,我们需要从外部来设置计划任务执行的时间和方式。所以在本文中,我们着重讲解一下如何动态地配置计划任务。 和Spring对异步任务的支持一样,通过@Enabl...

Oct 29, 2022
Spring/Spring Boot下如何动态配置计划任务

Spring 6/Spring Boot 3新特性:优雅的业务异常处理

当你使用Spring Boot(Spring MVC)进行RESTful API开发的时候,你会发现HTTP的状态码很多时候不能足够有效的传递错误的信息。 HTTP里有一个RFC 7807规范:https://www.rfc-editor.org/rfc/rfc7807。这个规范里定义了HTTP API的“问题细节”(Problem Details)内容。 该规范定义了一个“问题细节”(Problem Details),用它来携带HTTP错误返回信息,避免自定义新的错误返回格式。我们通常情况下是...

Oct 28, 2022
Spring 6/Spring Boot 3新特性:优雅的业务异常处理

汪云飞的工具箱

24 posts