Part 5 - Async Load Component

本文介绍了如何在大型项目中利用ES2015的import()方法动态加载PageB组件,实现资源分包和异步加载,提升首屏加载速度。通过实例展示了如何在Webpack 4.0中配置和使用import(),以及其在实际开发中的应用价值。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

一般来说,我们在开发时,总是将所有的资源(js,css,image)都打包到一个boudle里。

有时候,我们需要将这些资源进行分包处理,和异步并行加载他们。

我们可以怎么做?

ES2015中,import()这个方法可以在运行时动态地加载ES2015 modules

webpack4.0或者更高版本都支持这个import()方法。

Import()方法会为我们返回一个promise function,我们可以像使用promise function一样使用它。

你可以在这条link查看更多的信息,https://webpack.js.org/api/module-methods/#dynamic-expressions-in-import

现在,让我们看看在代码中如何使用。

Step 1

首先,在项目js folder 中创建一个名为PageB.jsx的组件。如下:

import React from "react";
export default class PageB extends React.Component{
    constructor(props){
        super(props)
    }
    render(){
        return <span>PageB - component</span>
    }
}

Step 2

打开Main.js,修改代码如下:

import React from 'react'

import PageA from '@/js/PageA'

import '../css/Main.css'
import '../css/Main.scss' 

export default class Main extends React.Component{
    constructor(props){
        super(props)
        this.state={
            Component:PageA
        }
    }
    changePage(flag){
        if(flag=='A'){
            this.setState({
                Component:PageA
            })
        }
        else{
            import(/* webpackChunkName:"pageB" */'../js/PageB').then((c)=>{
                this.setState({
                    Component:c.default
                })
            })
        }
    }
    render(){
        let Component=this.state.Component
        return(
            <>
                <h1 className='color-red'>
                    reactapp
                    <br></br>
                    <span>blue-color</span>
                </h1>
                <a style={{margin:'10px 10px 50px 10px'}} href='#' onClick={()=>{this.changePage('B')}}>PageB</a>
                <br></br>
                <Component></Component>
            </>
        )
    }
}

在上面的代码中,我们使用了一个使用了import()方法来动态加载PageB组件。如下:

 import(/* webpackChunkName:"pageB" */'../js/PageB').then((c)=>{
                this.setState({
                    Component:c.default
                })
            })

代码 /* webpackChunkName:"pageB" */ 将会将组件PageB进行分包处理,用于异步加载,其中,pageBboudle文件名。

 

Step 3

现在,让我们来看看在浏览器中的效果。

第一次加载时,我们看到页面显示的是PageA组件,只加载了reactapp.js这个boudle

当我们点击PageB这个link,会自动为我们异步加载PageB这个boudle,如下图:

 

 

总结:当项目非常大的时候,这个Import()就会变得非常实用,上面演示的只是怎么使用。在实际项目中,我们可以做成vue router那样的路由配置,用于异步加载组件,减少浏览器第一次加载资源的大小。

{"openapi":"3.1.0","info":{"title":"Auto FA Task Center","version":"0.1.0"},"paths":{"/jobs/":{"get":{"tags":["Jobs"],"summary":"Read Jobs","operationId":"read_jobs_jobs__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Job"},"type":"array","title":"Response Read Jobs Jobs Get"}}}}}}},"/jobs/remove/":{"post":{"tags":["Jobs"],"summary":"Remove Job Use Id","operationId":"remove_job_use_id_jobs_remove__post","parameters":[{"name":"job_id","in":"query","required":true,"schema":{"type":"string","title":"Job Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Remove Job Use Id Jobs Remove Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/Add/update_machine_states":{"post":{"tags":["Jobs"],"summary":"Add Update Machine States Job","operationId":"add_update_machine_states_job_jobs_Add_update_machine_states_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_update_machine_states_job_jobs_Add_update_machine_states_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/Add/down_load_unit_test_detail":{"post":{"tags":["Jobs"],"summary":"Add Down Load Unit Test Detail Job","operationId":"add_down_load_unit_test_detail_job_jobs_Add_down_load_unit_test_detail_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_down_load_unit_test_detail_job_jobs_Add_down_load_unit_test_detail_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"tags":["Scheduler"],"summary":"App Stage","operationId":"app_stage__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/start_auto_run":{"get":{"tags":["Scheduler"],"summary":"App Start","operationId":"app_start_start_auto_run_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/pause_auto_run":{"get":{"tags":["Scheduler"],"summary":"App Pause","operationId":"app_pause_pause_auto_run_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/stop_auto_run":{"get":{"tags":["Scheduler"],"summary":"App Stop","operationId":"app_stop_stop_auto_run_get","parameters":[{"name":"wait","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Wait"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records?system_fail={system_fail}":{"post":{"tags":["Records"],"summary":"Get Fail Records","operationId":"get_fail_records_records_system_fail__system_fail__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitTestDetail"},"type":"array","title":"Response Get Fail Records Records System Fail System Fail Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records/":{"post":{"tags":["Records"],"summary":"Get Fail Records","operationId":"get_fail_records_records__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitTestDetail"},"type":"array","title":"Response Get Fail Records Records Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records/download?system_fail={system_fail}":{"post":{"tags":["Records"],"summary":"Get Fail Records","operationId":"get_fail_records_records_download_system_fail__system_fail__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records/download":{"post":{"tags":["Records"],"summary":"Get Fail Records","operationId":"get_fail_records_records_download_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records/delete":{"post":{"tags":["Records"],"summary":"Delete Fail Records","operationId":"delete_fail_records_records_delete_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"integer","title":"Response Delete Fail Records Records Delete Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/records/Add":{"post":{"tags":["Records"],"summary":"Add Records","operationId":"add_records_records_Add_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitTestDetail"},"type":"array","title":"Records"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UnitTestDetail"},"type":"array","title":"Response Add Records Records Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/fa_items/Add":{"post":{"tags":["FA_Items"],"summary":"Fa Items Add","operationId":"fa_items_add_fa_items_Add_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FailFAItem"},"type":"array","title":"Fail Items"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Fa Items Add Fa Items Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/fa_items/read":{"post":{"tags":["FA_Items"],"summary":"Fa Items Read","operationId":"fa_items_read_fa_items_read_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FailFAItem"},"type":"array","title":"Response Fa Items Read Fa Items Read Post"}}}}}}},"/fa_items/import":{"post":{"tags":["FA_Items"],"summary":"Import Mapping List","operationId":"import_mapping_list_fa_items_import_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FailFAItem"},"type":"array","title":"Response Import Mapping List Fa Items Import Post"}}}}}}},"/dt_items/read":{"post":{"tags":["DT_Items"],"summary":"Dt Items Read","operationId":"dt_items_read_dt_items_read_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ErrorCode"},"type":"array","title":"Response Dt Items Read Dt Items Read Post"}}}}}}},"/dt_items/Add":{"post":{"tags":["DT_Items"],"summary":"Dt Items Add","operationId":"dt_items_add_dt_items_Add_post","requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ErrorCode"},"type":"array","title":"Dt Items"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Dt Items Add Dt Items Add Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/dt_items/import":{"post":{"tags":["DT_Items"],"summary":"Import Mapping List","operationId":"import_mapping_list_dt_items_import_post","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ErrorCode"},"type":"array","title":"Response Import Mapping List Dt Items Import Post"}}}}}}},"/machine_states/":{"post":{"tags":["MachineState"],"summary":"Get Machine States","operationId":"get_machine_states_machine_states__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MachineStateFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/MachineStateDataQuery"},"type":"array","title":"Response Get Machine States Machine States Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/Add/down_load_raw_data_for_tossing":{"post":{"tags":["Jobs"],"summary":"Add Down Load Raw Data For Tossing Job","operationId":"add_down_load_raw_data_for_tossing_job_jobs_Add_down_load_raw_data_for_tossing_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_down_load_raw_data_for_tossing_job_jobs_Add_down_load_raw_data_for_tossing_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/jobs/Add/down_load_raw_data_for_auto_jmp":{"post":{"tags":["Jobs"],"summary":"Add Down Load Raw Data For Auto Jmp Job","operationId":"add_down_load_raw_data_for_auto_jmp_job_jobs_Add_down_load_raw_data_for_auto_jmp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Body_add_down_load_raw_data_for_auto_jmp_job_jobs_Add_down_load_raw_data_for_auto_jmp_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/raw_data_headers":{"get":{"tags":["InsightRawData"],"summary":"Read Raw Data Headers","operationId":"read_raw_data_headers_raw_data_headers_get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InsightRawDataResponse"},"title":"Response Read Raw Data Headers Raw Data Headers Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/raw_data":{"get":{"tags":["InsightRawData"],"summary":"Read Raw Data","operationId":"read_raw_data_raw_data_get","parameters":[{"name":"skip","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Skip"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/tossing":{"post":{"tags":["Tossing"],"summary":"Get Tossing","description":"获取所有ExchangeUser","operationId":"get_tossing_tossing_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StationTypeFilterDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_add_down_load_raw_data_for_auto_jmp_job_jobs_Add_down_load_raw_data_for_auto_jmp_post":{"properties":{"trigger":{"$ref":"#/components/schemas/IntervalTriggerArgs"},"data_setting":{"$ref":"#/components/schemas/DownLoadRawDataJobSettingForTossing"}},"type":"object","required":["trigger","data_setting"],"title":"Body_add_down_load_raw_data_for_auto_jmp_job_jobs_Add_down_load_raw_data_for_auto_jmp_post"},"Body_add_down_load_raw_data_for_tossing_job_jobs_Add_down_load_raw_data_for_tossing_post":{"properties":{"trigger":{"$ref":"#/components/schemas/IntervalTriggerArgs"},"data_setting":{"$ref":"#/components/schemas/DownLoadRawDataJobSettingForTossing"}},"type":"object","required":["trigger","data_setting"],"title":"Body_add_down_load_raw_data_for_tossing_job_jobs_Add_down_load_raw_data_for_tossing_post"},"Body_add_down_load_unit_test_detail_job_jobs_Add_down_load_unit_test_detail_post":{"properties":{"trigger":{"$ref":"#/components/schemas/IntervalTriggerArgs"},"data_setting":{"$ref":"#/components/schemas/TestUnitDetailsJobSetting"}},"type":"object","required":["trigger","data_setting"],"title":"Body_add_down_load_unit_test_detail_job_jobs_Add_down_load_unit_test_detail_post"},"Body_add_update_machine_states_job_jobs_Add_update_machine_states_post":{"properties":{"trigger":{"$ref":"#/components/schemas/IntervalTriggerArgs"},"data_setting":{"$ref":"#/components/schemas/HiveMachineStateJobSetting"}},"type":"object","required":["trigger","data_setting"],"title":"Body_add_update_machine_states_job_jobs_Add_update_machine_states_post"},"CutTimeWeekOffset":{"properties":{"D1":{"type":"integer","title":"D1","default":0},"D2":{"type":"integer","title":"D2","default":0},"D3":{"type":"integer","title":"D3","default":0},"D4":{"type":"integer","title":"D4","default":0},"D5":{"type":"integer","title":"D5","default":0},"D6":{"type":"integer","title":"D6","default":0},"D7":{"type":"integer","title":"D7","default":0}},"type":"object","title":"CutTimeWeekOffset"},"DownLoadRawDataJobSettingForTossing":{"properties":{"setting_index":{"type":"integer","title":"Setting Index","default":0},"ReportCommand":{"type":"string","title":"Reportcommand","default":"DownLoadRawData"},"report_id":{"type":"string","title":"Report Id","default":""},"FixedStartTime":{"type":"string","format":"date-time","title":"Fixedstarttime"},"FixedEndTime":{"type":"string","format":"date-time","title":"Fixedendtime"},"StartHourAnchor":{"type":"string","enum":["Start","End"],"title":"Starthouranchor","default":"Start"},"StartHourOffset":{"type":"integer","title":"Starthouroffset","default":0},"EndHourOffset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Endhouroffset"},"shift_hour":{"type":"integer","title":"Shift Hour","default":7},"shift_week_offset":{"$ref":"#/components/schemas/ShiftWeekOffset"},"cut_time_week_offset":{"$ref":"#/components/schemas/CutTimeWeekOffset"},"SITE":{"type":"string","title":"Site","default":"LZSH"},"SITENAME":{"items":{"type":"string"},"type":"array","title":"Sitename","default":[]},"PROJECT":{"type":"string","title":"Project","default":""},"PROJECT_CODE":{"type":"string","title":"Project Code","default":"D48"},"STATIONTYPE":{"items":{"type":"string"},"type":"array","title":"Stationtype","default":[]},"product_code":{"items":{"type":"string"},"type":"array","title":"Product Code","default":[]},"station_type_list":{"items":{"items":{"type":"string"},"type":"array"},"type":"array","title":"Station Type List","default":[]},"line_list":{"items":{"type":"string"},"type":"array","title":"Line List","default":[]},"mail_recipients":{"$ref":"#/components/schemas/ReportRecipients","default":{"bcc":["Xiaoze.Wang@luxsan-ict.cn","Nan1.Chen@luxsan-ict.cn"]}},"parametricType":{"items":{"$ref":"#/components/schemas/ParametricType"},"type":"array","title":"Parametrictype","default":[]},"attributes":{"items":{"type":"string"},"type":"array","title":"Attributes","default":[]},"modules":{"items":{"type":"string"},"type":"array","title":"Modules","default":[]}},"type":"object","required":["shift_week_offset","cut_time_week_offset"],"title":"DownLoadRawDataJobSettingForTossing"},"ErrorCode":{"properties":{"Error_ID":{"type":"string","title":"Error Id","default":""},"Station":{"type":"string","title":"Station"},"Error_description":{"type":"string","title":"Error Description"},"Error_type":{"type":"string","title":"Error Type"},"Component":{"type":"string","title":"Component"},"Sub_Component":{"type":"string","title":"Sub Component"},"Error_Index":{"type":"integer","title":"Error Index"},"Action_Index":{"type":"integer","title":"Action Index"},"RiskLevel":{"type":"string","enum":["High","Medium","Low"],"title":"Risklevel","default":"Low"},"ICT_DRI":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ict Dri","default":""},"Allie_DRI":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allie Dri","default":""},"Code":{"type":"string","title":"Code"},"category":{"type":"string","title":"Category"},"Error_description_ch":{"type":"string","title":"Error Description Ch"},"Issue_description":{"type":"string","title":"Issue Description"},"Root_cause":{"type":"string","title":"Root Cause"},"Analysis_step":{"type":"string","title":"Analysis Step"},"Short_term":{"type":"string","title":"Short Term"},"Long_term":{"type":"string","title":"Long Term"},"Action":{"type":"string","title":"Action"},"images_count":{"type":"integer","title":"Images Count"}},"type":"object","required":["Station","Error_description","Error_type","Component","Sub_Component","Error_Index","Action_Index","Code","category","Error_description_ch","Issue_description","Root_cause","Analysis_step","Short_term","Long_term","Action","images_count"],"title":"ErrorCode"},"FactoryMetricsFilterData":{"properties":{"station_type":{"items":{"type":"string"},"type":"array","title":"Station Type"},"line_type":{"items":{"type":"string"},"type":"array","title":"Line Type"},"product":{"items":{"type":"string"},"type":"array","title":"Product"},"site":{"items":{"type":"string"},"type":"array","title":"Site"},"apple_code":{"items":{"type":"string"},"type":"array","title":"Apple Code"}},"type":"object","title":"FactoryMetricsFilterData"},"FailFAItem":{"properties":{"failItemId":{"type":"string","title":"Failitemid","default":""},"equipmentType":{"type":"string","title":"Equipmenttype","default":""},"displayName":{"type":"string","title":"Displayname","default":""},"MainPart":{"type":"string","title":"Mainpart","default":""},"SmallPart":{"type":"string","title":"Smallpart","default":""},"test":{"type":"string","title":"Test","default":""},"message":{"type":"string","title":"Message","default":""},"RiskLevel":{"type":"string","enum":["High","Medium","Low"],"title":"Risklevel","default":"Low"},"ICT_DRI":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ict Dri","default":""},"Allie_DRI":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Allie Dri","default":""},"image_count":{"type":"integer","title":"Image Count","default":0},"NG":{"type":"string","title":"Ng","default":""},"OK":{"type":"string","title":"Ok","default":""},"Issue_description":{"type":"string","title":"Issue Description","default":""},"Analysis_step":{"type":"string","title":"Analysis Step","default":""},"Root_cause":{"type":"string","title":"Root Cause","default":""},"Short_term":{"type":"string","title":"Short Term","default":""},"Long_term":{"type":"string","title":"Long Term","default":""},"Action":{"type":"string","title":"Action","default":""}},"type":"object","title":"FailFAItem"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HiveMachineStateJobSetting":{"properties":{"setting_index":{"type":"integer","title":"Setting Index","default":0},"ReportCommand":{"type":"string","title":"Reportcommand","default":"HiveMachineState"},"StartHourOffset":{"type":"integer","title":"Starthouroffset","default":0},"EndHourOffset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Endhouroffset"},"shift_hour":{"type":"integer","title":"Shift Hour","default":7},"shift_week_offset":{"$ref":"#/components/schemas/ShiftWeekOffset"},"cut_time_week_offset":{"$ref":"#/components/schemas/CutTimeWeekOffset"},"kind":{"type":"string","enum":["MACHINESTATE","ERRORDATA","MACHINEDATA"],"title":"Kind","default":"MACHINESTATE"},"filter_data":{"$ref":"#/components/schemas/FactoryMetricsFilterData"}},"type":"object","required":["shift_week_offset","cut_time_week_offset","filter_data"],"title":"HiveMachineStateJobSetting"},"InitStation":{"properties":{"id":{"type":"integer","title":"Id"},"active":{"type":"boolean","title":"Active"},"last_updated_at":{"type":"string","format":"date-time","title":"Last Updated At"},"last_updated_by":{"type":"string","title":"Last Updated By"},"authorized":{"type":"boolean","title":"Authorized"},"publisher_id":{"type":"string","title":"Publisher Id"},"product":{"type":"string","title":"Product"},"build_type":{"type":"string","title":"Build Type"},"site":{"type":"string","title":"Site"},"building":{"type":"string","title":"Building"},"line":{"type":"string","title":"Line"},"line_name":{"type":"string","title":"Line Name","default":""},"line_type":{"type":"string","title":"Line Type"},"station_type":{"type":"string","title":"Station Type"},"vendor":{"type":"string","title":"Vendor"},"sequence":{"type":"integer","title":"Sequence"},"instance":{"type":"integer","title":"Instance"},"ip_address":{"type":"string","title":"Ip Address"},"registered_mac_addresses":{"type":"string","title":"Registered Mac Addresses"},"mac_addresses_non_usb":{"type":"string","title":"Mac Addresses Non Usb"},"mac_addresses_usb":{"type":"string","title":"Mac Addresses Usb"},"gateway_ip_address":{"type":"string","title":"Gateway Ip Address"},"rfid":{"type":"string","title":"Rfid"},"groundhog_id":{"type":"string","title":"Groundhog Id"},"station_id":{"type":"string","title":"Station Id","default":""},"entity":{"type":"string","title":"Entity","default":""}},"type":"object","required":["id","active","last_updated_at","last_updated_by","authorized","publisher_id","product","build_type","site","building","line","line_type","station_type","vendor","sequence","instance","ip_address","registered_mac_addresses","mac_addresses_non_usb","mac_addresses_usb","gateway_ip_address","rfid","groundhog_id"],"title":"InitStation"},"InsightModuleDataResponse":{"properties":{"ModuleName":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Modulename","default":""},"SerialNumber":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Serialnumber","default":""},"Vendor":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Vendor","default":""},"InfoCode":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Infocode","default":""},"LotCode":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Lotcode","default":""},"DateCode":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Datecode","default":""},"PartNumber":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Partnumber","default":""}},"type":"object","title":"InsightModuleDataResponse"},"InsightRawDataResponse":{"properties":{"SeriesID":{"type":"string","title":"Seriesid"},"Site":{"type":"string","title":"Site","default":"PGPD"},"Product":{"type":"string","title":"Product","default":"D48"},"SerialNumber":{"type":"string","title":"Serialnumber","default":"C7CHDF004FR0000NBC"},"SpecialBuildName":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Specialbuildname","default":""},"SpecialBuildDescription":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Specialbuilddescription","default":""},"UnitNumber":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"null"}],"title":"Unitnumber","default":""},"StationID":{"type":"string","title":"Stationid","default":"PGPD_F03-4FGC-25_1_MMV"},"Line":{"type":"string","title":"Line","default":""},"StationType":{"type":"string","title":"Stationtype","default":""},"StationInstanceNumber":{"type":"integer","title":"Stationinstancenumber","default":0},"TestPassFailStatus":{"type":"string","title":"Testpassfailstatus","default":"PASS"},"StartTime":{"type":"string","format":"date-time","title":"Starttime","default":"45695.111875"},"EndTime":{"type":"string","format":"date-time","title":"Endtime","default":"45695.1118865741"},"Version":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Version","default":"BZ-03.41-01.02-03.21-NN.NN"},"ListOfFailingTests":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Listoffailingtests","default":""},"test_data":{"items":{"$ref":"#/components/schemas/InsightRawDataTestDataResponse"},"type":"array","title":"Test Data"},"module":{"items":{"$ref":"#/components/schemas/InsightModuleDataResponse"},"type":"array","title":"Module"}},"type":"object","required":["test_data","module"],"title":"InsightRawDataResponse"},"InsightRawDataTestDataResponse":{"properties":{"KeyType":{"type":"string","enum":["PARAMETRIC","ATTRIBUTE","HEADER","MODULE"],"title":"Keytype","default":"PARAMETRIC"},"KeyName":{"type":"string","title":"Keyname","default":""},"Value":{"type":"number","title":"Value","default":0}},"type":"object","title":"InsightRawDataTestDataResponse"},"IntervalTriggerArgs":{"properties":{"weeks":{"type":"integer","title":"Weeks","default":0},"days":{"type":"integer","title":"Days","default":0},"hours":{"type":"integer","title":"Hours","default":0},"minutes":{"type":"integer","title":"Minutes","default":0},"seconds":{"type":"integer","title":"Seconds","default":0},"start_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"Start Date"},"end_date":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"End Date"},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Timezone","default":"Asia/Shanghai"},"jitter":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Jitter"}},"type":"object","title":"IntervalTriggerArgs"},"Job":{"properties":{"id":{"type":"string","title":"Id"},"next_run_time":{"type":"string","format":"date-time","title":"Next Run Time"},"state":{"type":"object","title":"State"}},"type":"object","required":["id","next_run_time"],"title":"Job"},"MachineStateDataQuery":{"properties":{"message_id":{"type":"string","title":"Message Id"},"kind":{"type":"string","title":"Kind","default":"MACHINESTATE"},"station_type":{"type":"string","title":"Station Type"},"machine_state":{"type":"integer","title":"Machine State"},"state_change_time":{"type":"string","format":"date-time","title":"State Change Time"},"code":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Code"},"error_message":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Error Message"},"sub_station":{"anyOf":[{"type":"string"},{"type":"number"}],"title":"Sub Station","default":""},"error_id":{"type":"string","title":"Error Id","default":""},"publisher_id":{"type":"string","title":"Publisher Id"},"is_closed":{"type":"boolean","title":"Is Closed","default":false},"next_message_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Message Id"},"next_state_change_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Next State Change Time"},"state_start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"State Start Time"},"state_end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"State End Time"},"state_duration_time":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"State Duration Time"},"state_duration_minute":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"State Duration Minute"},"station":{"$ref":"#/components/schemas/InitStation"},"error_detail":{"anyOf":[{"$ref":"#/components/schemas/ErrorCode"},{"type":"null"}]}},"type":"object","required":["message_id","station_type","machine_state","state_change_time","code","error_message","publisher_id","station"],"title":"MachineStateDataQuery"},"MachineStateFilterDict":{"properties":{"station_type":{"items":{"type":"string"},"type":"array","title":"Station Type"},"machine_state":{"items":{"type":"integer"},"type":"array","title":"Machine State"},"state_duration_time":{"prefixItems":[{"type":"integer"},{"type":"integer"}],"type":"array","maxItems":2,"minItems":2,"title":"State Duration Time","default":[0,999999]},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"}},"type":"object","title":"MachineStateFilterDict"},"ParametricType":{"properties":{"stationType":{"type":"string","title":"Stationtype","default":""},"overlayVersion":{"items":{"type":"string"},"type":"array","title":"Overlayversion","default":[]},"overlayVersionAll":{"type":"boolean","title":"Overlayversionall","default":true},"keys":{"items":{"type":"string"},"type":"array","title":"Keys","default":[]}},"type":"object","title":"ParametricType"},"ReportRecipients":{"properties":{"to":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"To"},"cc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Cc"},"bcc":{"anyOf":[{"items":{"type":"string","format":"email"},"type":"array"},{"type":"null"}],"title":"Bcc"}},"type":"object","title":"ReportRecipients"},"ShiftWeekOffset":{"properties":{"D1":{"type":"integer","title":"D1","default":0},"D2":{"type":"integer","title":"D2","default":0},"D3":{"type":"integer","title":"D3","default":0},"D4":{"type":"integer","title":"D4","default":0},"D5":{"type":"integer","title":"D5","default":0},"D6":{"type":"integer","title":"D6","default":0},"D7":{"type":"integer","title":"D7","default":0}},"type":"object","title":"ShiftWeekOffset"},"StationTypeFilterDict":{"properties":{"station_type":{"items":{"type":"string"},"type":"array","title":"Station Type"},"start_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Start Time"},"end_time":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"End Time"},"isSystem_fail":{"type":"boolean","title":"Issystem Fail","default":false}},"type":"object","required":["station_type"],"title":"StationTypeFilterDict"},"TestUnitDetailsJobSetting":{"properties":{"setting_index":{"type":"integer","title":"Setting Index","default":0},"ReportCommand":{"type":"string","title":"Reportcommand","default":"TestUnitDetails"},"report_id":{"type":"string","title":"Report Id","default":""},"StartHourAnchor":{"type":"string","enum":["Start","End"],"title":"Starthouranchor","default":"Start"},"StartHourOffset":{"type":"integer","title":"Starthouroffset","default":0},"EndHourOffset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Endhouroffset"},"SITENAME":{"items":{"type":"string"},"type":"array","title":"Sitename"},"PROJECT_CODE":{"items":{"type":"string"},"type":"array","title":"Project Code"},"shift_hour":{"type":"integer","title":"Shift Hour","default":7},"shift_week_offset":{"$ref":"#/components/schemas/ShiftWeekOffset"},"cut_time_week_offset":{"$ref":"#/components/schemas/CutTimeWeekOffset"},"station_type_list":{"items":{"type":"string"},"type":"array","title":"Station Type List"},"line_list":{"items":{"type":"string"},"type":"array","title":"Line List"},"site":{"items":{"type":"string"},"type":"array","title":"Site"},"result_type":{"type":"string","enum":["MultiPass","FirstPass"],"title":"Result Type","default":"MultiPass"},"result":{"items":{"type":"string","enum":["PASS","FAIL","RETEST"]},"type":"array","title":"Result"}},"type":"object","required":["shift_week_offset","cut_time_week_offset"],"title":"TestUnitDetailsJobSetting"},"UnitTestDetail":{"properties":{"subSubTest":{"type":"string","title":"Subsubtest"},"masked":{"type":"boolean","title":"Masked"},"highlightTestId":{"type":"string","title":"Highlighttestid","default":""},"localFolderId":{"type":"string","title":"Localfolderid","default":""},"failItemId":{"type":"string","title":"Failitemid","default":""},"displayName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Displayname","default":""},"configurationCode":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Configurationcode","default":""},"lineName":{"type":"string","title":"Linename"},"siteName":{"type":"string","title":"Sitename"},"productAssembly":{"type":"string","title":"Productassembly"},"units":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Units","default":""},"equipmentId":{"type":"string","title":"Equipmentid"},"equipmentType":{"type":"string","title":"Equipmenttype"},"parentBuild":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentbuild","default":""},"Name":{"type":"string","title":"Name"},"Result":{"type":"string","title":"Result"},"subTest":{"type":"string","title":"Subtest"},"lock":{"type":"boolean","title":"Lock","default":false},"testEndTime":{"type":"string","format":"date-time","title":"Testendtime"},"startTime":{"type":"string","format":"date-time","title":"Starttime"},"value":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Value","default":""},"childBuild":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Childbuild","default":""},"mfgYearWeek":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Mfgyearweek","default":""},"isSecured":{"type":"boolean","title":"Issecured"},"test":{"type":"string","title":"Test"},"fixtureId":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Fixtureid","default":""},"hashedSerialNumber":{"type":"string","title":"Hashedserialnumber"},"overlayVersion":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Overlayversion","default":""},"lowerLimit":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Lowerlimit","default":""},"message":{"type":"string","title":"Message","default":""},"headId":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Headid","default":""},"productCode":{"type":"string","title":"Productcode"},"productName":{"type":"string","title":"Productname","default":""},"qualifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Qualifier","default":""},"upperLimit":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"number"},{"type":"null"}],"title":"Upperlimit","default":""},"isSystem_fail":{"type":"boolean","title":"Issystem Fail","default":true}},"type":"object","required":["subSubTest","masked","lineName","siteName","productAssembly","equipmentId","equipmentType","Name","Result","subTest","testEndTime","startTime","isSecured","test","hashedSerialNumber","productCode"],"title":"UnitTestDetail"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
最新发布
05-31
<think>嗯,用户现在的问题是关于如何解析和使用OpenAPI3.1.0文档中的路径和模式定义。之前用户问的是前端框架的选择,现在转向了OpenAPI文档的解析,看起来他们可能在开发一个需要集成API的前端应用,或者在后端处理API文档生成。首先,我需要确认用户的需求。他们可能想通过解析OpenAPI文档来自动生成客户端代码、验证API请求,或者生成文档。不过用户提到的是“解析和理解”,所以重点可能在如何提取文档中的路径和模式信息。 用户之前的问题里引用了Swagger相关的资料,所以可能他们正在使用Swagger工具链,比如springfox或者Swashbuckle。但这次的问题是关于OpenAPI3.1.0,所以需要明确两者之间的关系。OpenAPI是规范,Swagger是实现工具之一。 接下来,我需要回忆OpenAPI3.1.0的结构。文档根对象包含openapi、info、paths、components等部分。路径和模式定义主要在paths和components/schemas下。每个路径下有HTTP方法,每个方法包含参数、请求体、响应等信息,而模式定义则使用JSONSchema格式。 用户想知道如何解析这些内容,可能需要具体的步骤。比如,使用哪种工具或库,如何遍历路径,如何引用模式定义。需要推荐一些常用的库,比如Java的Swagger Parser,Python的Prance,JS的Swagger-Parser。还要考虑如何处理$ref引用,因为模式可能分散在components中,需要通过解析器解析引用。同时,可能需要生成代码示例,比如如何用Python提取路径信息,或者如何解析模式定义。另外,用户可能想知道解析后的应用场景,比如生成客户端SDK、验证请求数据等。需要给出实际的应用例子,帮助用户理解如何利用解析后的数据。最后,要确保回答结构清晰,分步骤说明,并提供代码示例,这样用户能跟着操作。同时,生成的相关问题要围绕解析OpenAPI文档的深入问题,比如工具比较、版本差异、验证方法等。</think>### OpenAPI 3.1.0文档解析指南 解析OpenAPI文档需要理解其**结构化数据模型**,重点关注`paths`和`components/schemas`两个核心部分。以下是具体步骤和示例: --- #### 一、文档结构解析 1. **根对象** ```yaml openapi: 3.1.0 info: title: API文档 paths: /users: get: summary: 获取用户列表 components: schemas: User: type: object properties: id: { type: integer } name: { type: string } ``` - `paths`: 定义所有API端点及其HTTP方法(如GET/POST)[^2] - `components/schemas`: 存储可复用的数据模型(如User对象) 2. **路径参数与模式引用** ```yaml paths: /users/{id}: get: parameters: - name: id in: path required: true schema: { type: integer } responses: 200: content: application/json: schema: $ref: '#/components/schemas/User' ``` - 路径参数通过`parameters`定义,可嵌套引用`$ref`指向的模式[^1] --- #### 二、代码解析示例 使用JavaScript的`swagger-parser`库解析文档: ```javascript const SwaggerParser = require('swagger-parser'); async function parseOpenAPI() { const api = await SwaggerParser.dereference('openapi.yaml'); // 1. 遍历所有路径 Object.entries(api.paths).forEach(([path, methods]) => { console.log(`路径: ${path}`); // 2. 提取HTTP方法 Object.keys(methods).forEach(method => { console.log(`方法: ${method.toUpperCase()}`); // 3. 获取关联模式 const responseSchema = methods[method].responses['200']?.content['application/json']?.schema; if (responseSchema) console.log('响应模型:', responseSchema.$ref); }); }); } parseOpenAPI(); ``` - `dereference()`方法会解析所有`$ref`引用,生成完整文档对象[^2] --- #### 三、模式定义应用场景 1. **数据验证** ```python from openapi_spec_validator import validate_spec # 验证文档是否符合OpenAPI规范 validate_spec('openapi.yaml') ``` 2. **客户端SDK生成** 使用`openapi-generator`工具: ```bash openapi-generator generate -i openapi.yaml -g typescript-axios -o client-sdk ``` --- ### 关键注意事项 - **引用解析**:优先使用`dereference`解析后的文档,避免手动处理`$ref`指针 - **版本差异**:OpenAPI 3.1.0支持JSON Schema Draft 2020-12,需注意校验库的兼容性[^2] ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值