vb如何获取json内容

VB.NET中获取与解析JSON内容实用指南**

在当今的软件开发中,JSON（JavaScript Object Notation）因其轻量级、易读和易于解析的特性，已成为数据交换的主流格式之一，对于VB.NET开发者而言，如何从各种来源获取并解析JSON数据是一项至关重要的技能，本文将详细介绍在VB.NET中获取JSON内容并对其进行解析的常用方法和最佳实践。

获取JSON内容

在解析JSON之前,我们首先需要获取JSON字符串，获取JSON内容的途径多种多样，常见的包括：

从Web API获取：这是最常见的方式，通过HTTP请求从远程服务器获取JSON格式的响应数据。
从本地文件读取：JSON数据可能已经保存在本地的.json文件或其他文本文件中。
从数据库获取：数据库中的某些字段可能存储了JSON格式的字符串。
硬编码或程序生成：在测试或某些简单场景下，JSON字符串可能直接定义在代码中或由程序动态生成。

下面我们主要介绍前两种最常用的获取方式。

从Web API获取JSON内容

在VB.NET中，我们可以使用HttpClient类（推荐用于.NET 4.5及以上版本）来发送HTTP请求并获取响应内容。

示例代码：

Imports System.Net.Http
Imports System.Threading.Tasks
Imports System.Text
Public Class JsonFetcher
    Private ReadOnly _httpClient As HttpClient
    Public Sub New()
        _httpClient = New HttpClient()
        ' 可以设置User-Agent等默认头
        _httpClient.DefaultRequestHeaders.Add("User-Agent", "My VB JSON App/1.0")
    End Sub
    Public Async Function GetJsonFromUrlAsync(url As String) As Task(Of String)
        Try
            ' 发送GET请求并获取响应
            Dim response As HttpResponseMessage = Await _httpClient.GetAsync(url)
            ' 确保请求成功，否则抛出异常
            response.EnsureSuccessStatusCode()
            ' 读取响应内容为字符串
            Dim jsonString As String = Await response.Content.ReadAsStringAsync()
            Return jsonString
        Catch ex As HttpRequestException
            ' 处理网络错误、HTTP错误等
            Console.WriteLine($"Error fetching JSON from URL: {ex.Message}")
            Return Nothing
        Catch ex As Exception
            ' 处理其他异常
            Console.WriteLine($"An unexpected error occurred: {ex.Message}")
            Return Nothing
        End Try
    End Function
End Class
' 使用示例
' Public Sub Main()
'     Dim fetcher As New JsonFetcher()
'     Dim apiUrl As String = "https://api.example.com/data"
'     Dim jsonResult As String = Await fetcher.GetJsonFromUrlAsync(apiUrl)
'
'     If Not String.IsNullOrEmpty(jsonResult) Then
'         Console.WriteLine("Successfully fetched JSON:")
'         Console.WriteLine(jsonResult)
'         ' 在这里可以调用解析JSON的方法
'     End If
' End Sub

说明：

Async 和 Await 关键字用于异步编程，避免在请求网络时阻塞UI线程（如果是桌面应用）或服务器线程（如果是Web应用）。
EnsureSuccessStatusCode() 会在响应状态码表示失败时抛出异常。
ReadAsStringAsync() 异步读取响应内容为字符串。

从本地文件读取JSON内容

可以使用System.IO命名空间下的类来读取文件内容。

示例代码：

Imports System.IO
Public Function GetJsonFromFile(filePath As String) As String
    Try
        ' 检查文件是否存在
        If File.Exists(filePath) Then
            ' 读取文件全部内容
            Dim jsonString As String = File.ReadAllText(filePath)
            Return jsonString
        Else
            Console.WriteLine($"File not found: {filePath}")
            Return Nothing
        End If
    Catch ex As IOException
        Console.WriteLine($"Error reading file: {ex.Message}")
        Return Nothing
    Catch ex As Exception
        Console.WriteLine($"An unexpected error occurred: {ex.Message}")
        Return Nothing
    End Try
End Function
' 使用示例
' Public Sub Main()
'     Dim filePath As String = "C:\data\mydata.json"
'     Dim jsonResult As String = GetJsonFromFile(filePath)
'
'     If Not String.IsNullOrEmpty(jsonResult) Then
'         Console.WriteLine("Successfully read JSON from file:")
'         Console.WriteLine(jsonResult)
'         ' 在这里可以调用解析JSON的方法
'     End If
' End Sub

说明：

File.ReadAllText(filePath) 会直接读取文件的整个内容到一个字符串中，对于大文件，可能需要考虑使用StreamReader逐行或分块读取。

解析JSON内容

获取到JSON字符串后,下一步就是将其解析为VB.NET中可以操作的对象，如自定义类、字典列表等，在VB.NET中，解析JSON通常借助第三方库，因为.NET Framework本身并没有内置强大的JSON序列化/反序列化工具（直到.NET 6.0的System.Text.Json才成为主流，但很多旧项目或特定场景仍使用第三方库）。

常用JSON库推荐：

Newtonsoft.Json (Json.NET)：目前最流行、功能最全面的.NET JSON库，使用广泛，文档丰富。
System.Text.Json：.NET Core 3.0及后续版本（包括.NET 5/6/7/8）内置的JSON库，性能较好，且无需额外安装（对于新项目推荐）。
DataContractJsonSerializer：.NET Framework内置，但功能相对有限，使用不如前两者方便。

这里我们重点介绍Newtonsoft.Json和System.Text.Json的使用方法。

使用Newtonsoft.Json (Json.NET)

首先需要通过NuGet包管理器安装Newtonsoft.Json包。

步骤：

在Visual Studio中，右键点击项目 -> “管理NuGet程序包” -> 搜索“Newtonsoft.Json” -> 安装。

示例代码（解析JSON到自定义对象和字典列表）：

假设我们有以下JSON字符串：

{
  "name": "John Doe",
  "age": 30,
  "isStudent": false,
  "courses": [
    { "title": "Math", "credits": 3 },
    { "title": "Science", "credits": 4 }
  ],
  "address": {
    "street": "123 Main St",
    "city": "Anytown"
  }
}

定义对应的VB.NET类：

' 主对象类
Public Class Person
    Public Property [Name] As String
    Public Property Age As Integer
    Public Property IsStudent As Boolean
    Public Property Courses As List(Of Course)
    Public Property Address As Address
End Class
' 课程类
Public Class Course
    Public Property Title As String
    Public Property Credits As Integer
End Class
' 地址类
Public Class Address
    Public Property Street As String
    Public Property City As String
End Class

解析JSON：

Imports Newtonsoft.Json
Public Class JsonParserNewtonsoft
    Public Function ParseJsonToObject(jsonString As String) As Person
        Try
            ' 使用JsonConvert.DeserializeObject将JSON字符串转换为Person对象
            Dim person As Person = JsonConvert.DeserializeObject(Of Person)(jsonString)
            Return person
        Catch ex As JsonException
            Console.WriteLine($"Error parsing JSON: {ex.Message}")
            Return Nothing
        Catch ex As Exception
            Console.WriteLine($"An unexpected error occurred during parsing: {ex.Message}")
            Return Nothing
        End Try
    End Function
    ' 也可以解析为JObject/JArray来动态处理
    Public Function ParseJsonToDynamic(jsonString As String) As Newtonsoft.Json.Linq.JObject
        Try
            Return Newtonsoft.Json.Linq.JObject.Parse(jsonString)
        Catch ex As JsonException
            Console.WriteLine($"Error parsing JSON to dynamic: {ex.Message}")
            Return Nothing
        End Try
    End Function
End Class
' 使用示例
' Public Sub Main()
'     Dim jsonString As String = "{""name"":""John Doe"",""age"":30,""isStudent"":false,""courses"":[{""title"":""Math"",""credits"":3},{""title"":""Science"",""credits"":4}],""address"":{""street"":""123 Main St"",""city"":""Anytown""}}"
'     Dim parser As New JsonParserNewtonsoft()
'
'     ' 解析为强类型对象
'     Dim person As Person = parser.ParseJsonToObject(jsonString)
'     If person IsNot Nothing Then
'         Console.WriteLine($"Name: {person.Name}, Age: {person.Age}")
'         Console.WriteLine($"First course: {person.Courses(0).Title}")
'     End If
'
'     ' 解析为动态对象
'     Dim dynamicObj As Newtonsoft.Json.Linq.JObject = parser.ParseJsonToDynamic(jsonString)
'     If dynamicObj IsNot Nothing Then
'         Console.WriteLine($"Dynamic Name: {dynamicObj("name")}")
'         Console.WriteLine($"Dynamic City: {dynamicObj("address")("city")}")
'     End If
' End Sub