Page Not Found
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
We could not find what you were looking for.
Please contact the owner of the site that linked you to the original URL and let them know their link is broken.
register method",id:"the-register-method",level:3},{value:"The boot method",id:"the-boot-method",level:3},{value:"The shutdown method",id:"the-shutdown-method",level:3},{value:"Registering providers",id:"registering-providers",level:2},{value:"Choosing applications",id:"choosing-applications",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.a)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"service-providers",children:"Service Providers"}),"\n",(0,i.jsx)(n.p,{children:"Understand the purpose and how to use the Athenna service providers."}),"\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Service providers are the central place of all Athenna application bootstrapping.\nYour own application, as well as all of Athenna core services, are bootstrapped\nvia service providers."}),"\n",(0,i.jsx)(n.p,{children:'But what do we mean by "bootstrapped"? In general, we mean registering things,\nincluding registering service container bindings, retry strategies for your http\nrequests, booting your FakeApi. Service providers are the central place to\nconfigure your application.'}),"\n",(0,i.jsxs)(n.p,{children:["If you open the ",(0,i.jsx)(n.code,{children:".athennarc.json"})," file included with Athenna, you will see a\n",(0,i.jsx)(n.code,{children:"providers"})," array. These are all the service provider classes that will be\nloaded for your application. By default, a set of Athenna core service\nproviders are listed in this array. These providers bootstrap the core\nAthenna components, such as the http, route, controllers and others."]}),"\n",(0,i.jsx)(n.p,{children:"In this overview, you will learn how to write your own service providers and\nregister them with your Athenna application."}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["If you would like to learn more about how Athenna works internally, check\nout the ",(0,i.jsx)(n.a,{href:"/docs/architecture-concepts/application-lifecycle",children:"application lifecycle documentation section"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"writing-service-providers",children:"Writing service providers"}),"\n",(0,i.jsxs)(n.p,{children:["All service providers extend the ",(0,i.jsx)(n.code,{children:"ServiceProvider"})," class. Most service providers\ncontain a ",(0,i.jsx)(n.code,{children:"register"})," and a ",(0,i.jsx)(n.code,{children:"boot"})," method. Within the ",(0,i.jsx)(n.code,{children:"register"})," method, you should\nonly bind things into the service container. We will check lately why this\nbehavior. To create a new provider, use the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"node artisan make:provider AppProvider\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"the-register-method",children:["The ",(0,i.jsx)(n.code,{children:"register"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["As mentioned previously, within the ",(0,i.jsx)(n.code,{children:"register"})," method, you should only bind\nthings into the service container. You should never attempt to register any\npiece of functionality within the ",(0,i.jsx)(n.code,{children:"register"})," method. Otherwise, you may\naccidentally use a service provided by a service provider which has\nnot loaded yet."]}),"\n",(0,i.jsxs)(n.p,{children:["Let's take a look at a basic service provider. Within any of your service\nprovider methods, you always have access to the ",(0,i.jsx)(n.code,{children:"this.container"})," property\nwhich provides access to the service container:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\nimport { AppHelper } from '#app/helpers/AppHelper'\n\nexport default class AppProvider extends ServiceProvider {\n public register() {\n this.container.singleton('App/Helpers/AppHelper', AppHelper)\n }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This service provider only defines a ",(0,i.jsx)(n.code,{children:"register"})," method, and uses that method to\ndefine an implementation of ",(0,i.jsx)(n.code,{children:"AppHelper"})," in the service container. If you're\nnot yet familiar with Athenna service container, ",(0,i.jsx)(n.a,{href:"/docs/architecture-concepts/service-container",children:"check out its documentation"}),"."]}),"\n",(0,i.jsxs)(n.h3,{id:"the-boot-method",children:["The ",(0,i.jsx)(n.code,{children:"boot"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["So, what if we need to register a dependency that needs another dependency\nwithin our service provider? This should be done within the ",(0,i.jsx)(n.code,{children:"boot"})," method.\nThis method is called after all other service providers have been registered,\nmeaning you have access to all other services that have been registered by\nthe framework:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\nimport { AppHelper } from '#app/helpers/AppHelper'\n\nexport default class AppProvider extends ServiceProvider {\n public boot() {\n const appService = this.container.safeUse('App/Services/AppService')\n const appHelper = new AppHelper(appService)\n\n this.container.instance('App/Helpers/AppHelper', appHelper)\n }\n}\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"the-shutdown-method",children:["The ",(0,i.jsx)(n.code,{children:"shutdown"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"shutdown"})," method will be called when the application is going down for\nsome reason. This method is extremely useful for graceful shutdown the\napplication, and it's used in providers such as ",(0,i.jsx)(n.code,{children:"HttpServerProvider"})," and\n",(0,i.jsx)(n.code,{children:"DatabaseProvider"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\n\nexport default class AppProvider extends ServiceProvider {\n public async shutdown() {\n const appHelper = this.container.use('App/Helpers/AppHelper')\n\n if (!appHelper) {\n return\n }\n\n await appHelper.close()\n }\n}\n"})}),"\n",(0,i.jsx)(n.h2,{id:"registering-providers",children:"Registering providers"}),"\n",(0,i.jsxs)(n.p,{children:["All service providers are registered in the ",(0,i.jsx)(n.code,{children:".athennarc.json file"}),". This file\ncontains a ",(0,i.jsx)(n.code,{children:"providers"})," array where you can list the class names of your service\nproviders. By default, a set of Athenna core service providers are listed in\nthis array. These providers bootstrap the core Athenna components, such as\nthe http, route, services and others."]}),"\n",(0,i.jsxs)(n.p,{children:["If you are using the ",(0,i.jsx)(n.code,{children:"make:provider"})," command to create providers, Athenna\nwill automatically register the provider for you in this array, but if you\nmight need to register it manually, just add the path to it to the array:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "providers": [\n // Other service providers...\n\n "#providers/AppProvider"\n ]\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"choosing-applications",children:"Choosing applications"}),"\n",(0,i.jsxs)(n.p,{children:["In some cases you want that your provider only runs for a determined type of\nAthenna applications. For example, I have a ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," that connects\nwith some database if I don't have an Artisan command that do some work\ninside this database, why I would need to run this ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," when\nrunning Artisan application and commands?"]}),"\n",(0,i.jsxs)(n.p,{children:["To solve this problem you can use the ",(0,i.jsx)(n.code,{children:"environment"})," getter to choose the\napplications that could run this provider:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\n\nexport default class MockedDbProvider extends ServiceProvider {\n public get environment() {\n return ['http', 'repl']\n }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now when running Artisan application and commands, ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," will be\nignored."]}),"\n",(0,i.jsx)(n.p,{children:"The following environments are available by default in Athenna at this moment:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"http"}),"\n",(0,i.jsx)(n.li,{children:"repl"}),"\n",(0,i.jsx)(n.li,{children:"console"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["You could also create your own environments. In your ",(0,i.jsx)(n.code,{children:"Path.bootstrap('main.ts')"})," file\nyou can add an ",(0,i.jsx)(n.code,{children:"environments"})," option when calling ",(0,i.jsx)(n.code,{children:"Ignite.load()"})," method:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { Ignite } from '@athenna/core'\n\nconst ignite = await new Ignite().load(import.meta.url, {\n environments: ['myEnv']\n})\n\nawait ignite.httpServer()\n"})}),"\n",(0,i.jsxs)(n.p,{children:["All of your environments will be merged with Athenna default ones when running\nyour application. This means that in the example above, when running your\nhttp server, the providers bootstrapped will be only the ones that got the\nenvironments getter returning ",(0,i.jsx)(n.code,{children:"['*']"})," and ",(0,i.jsx)(n.code,{children:"['myEnv', 'http']"}),"."]})]})}function l(e={}){const{wrapper:n}={...(0,t.a)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},1151:(e,n,r)=>{r.d(n,{Z:()=>c,a:()=>s});var i=r(7294);const t={},o=i.createContext(t);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
+"use strict";(self.webpackChunk_athenna_docs=self.webpackChunk_athenna_docs||[]).push([[8459],{6170:(e,n,r)=>{r.r(n),r.d(n,{assets:()=>a,contentTitle:()=>s,default:()=>l,frontMatter:()=>o,metadata:()=>c,toc:()=>d});var i=r(4848),t=r(8453);const o={title:"Service Providers",sidebar_position:3,description:"Understand the purpose and how to use the Athenna service providers."},s="Service Providers",c={id:"architecture-concepts/service-providers",title:"Service Providers",description:"Understand the purpose and how to use the Athenna service providers.",source:"@site/docs/architecture-concepts/service-providers.mdx",sourceDirName:"architecture-concepts",slug:"/architecture-concepts/service-providers",permalink:"/docs/architecture-concepts/service-providers",draft:!1,unlisted:!1,editUrl:"https://github.com/AthennaIO/Docs/tree/main/docs/architecture-concepts/service-providers.mdx",tags:[],version:"current",sidebarPosition:3,frontMatter:{title:"Service Providers",sidebar_position:3,description:"Understand the purpose and how to use the Athenna service providers."},sidebar:"tutorialSidebar",previous:{title:"Service Container",permalink:"/docs/architecture-concepts/service-container"},next:{title:"Facades",permalink:"/docs/architecture-concepts/facades"}},a={},d=[{value:"Introduction",id:"introduction",level:2},{value:"Writing service providers",id:"writing-service-providers",level:2},{value:"The register method",id:"the-register-method",level:3},{value:"The boot method",id:"the-boot-method",level:3},{value:"The shutdown method",id:"the-shutdown-method",level:3},{value:"Registering providers",id:"registering-providers",level:2},{value:"Choosing applications",id:"choosing-applications",level:2}];function h(e){const n={a:"a",admonition:"admonition",code:"code",h1:"h1",h2:"h2",h3:"h3",li:"li",p:"p",pre:"pre",ul:"ul",...(0,t.R)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(n.h1,{id:"service-providers",children:"Service Providers"}),"\n",(0,i.jsx)(n.p,{children:"Understand the purpose and how to use the Athenna service providers."}),"\n",(0,i.jsx)(n.h2,{id:"introduction",children:"Introduction"}),"\n",(0,i.jsx)(n.p,{children:"Service providers are the central place of all Athenna application bootstrapping.\nYour own application, as well as all of Athenna core services, are bootstrapped\nvia service providers."}),"\n",(0,i.jsx)(n.p,{children:'But what do we mean by "bootstrapped"? In general, we mean registering things,\nincluding registering service container bindings, retry strategies for your http\nrequests, booting your FakeApi. Service providers are the central place to\nconfigure your application.'}),"\n",(0,i.jsxs)(n.p,{children:["If you open the ",(0,i.jsx)(n.code,{children:".athennarc.json"})," file included with Athenna, you will see a\n",(0,i.jsx)(n.code,{children:"providers"})," array. These are all the service provider classes that will be\nloaded for your application. By default, a set of Athenna core service\nproviders are listed in this array. These providers bootstrap the core\nAthenna components, such as the http, route, controllers and others."]}),"\n",(0,i.jsx)(n.p,{children:"In this overview, you will learn how to write your own service providers and\nregister them with your Athenna application."}),"\n",(0,i.jsx)(n.admonition,{type:"tip",children:(0,i.jsxs)(n.p,{children:["If you would like to learn more about how Athenna works internally, check\nout the ",(0,i.jsx)(n.a,{href:"/docs/architecture-concepts/application-lifecycle",children:"application lifecycle documentation section"}),"."]})}),"\n",(0,i.jsx)(n.h2,{id:"writing-service-providers",children:"Writing service providers"}),"\n",(0,i.jsxs)(n.p,{children:["All service providers extend the ",(0,i.jsx)(n.code,{children:"ServiceProvider"})," class. Most service providers\ncontain a ",(0,i.jsx)(n.code,{children:"register"})," and a ",(0,i.jsx)(n.code,{children:"boot"})," method. Within the ",(0,i.jsx)(n.code,{children:"register"})," method, you should\nonly bind things into the service container. We will check lately why this\nbehavior. To create a new provider, use the following command:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-bash",children:"node artisan make:provider AppProvider\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"the-register-method",children:["The ",(0,i.jsx)(n.code,{children:"register"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["As mentioned previously, within the ",(0,i.jsx)(n.code,{children:"register"})," method, you should only bind\nthings into the service container. You should never attempt to register any\npiece of functionality within the ",(0,i.jsx)(n.code,{children:"register"})," method. Otherwise, you may\naccidentally use a service provided by a service provider which has\nnot loaded yet."]}),"\n",(0,i.jsxs)(n.p,{children:["Let's take a look at a basic service provider. Within any of your service\nprovider methods, you always have access to the ",(0,i.jsx)(n.code,{children:"this.container"})," property\nwhich provides access to the service container:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\nimport { AppHelper } from '#app/helpers/AppHelper'\n\nexport default class AppProvider extends ServiceProvider {\n public register() {\n this.container.singleton('App/Helpers/AppHelper', AppHelper)\n }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["This service provider only defines a ",(0,i.jsx)(n.code,{children:"register"})," method, and uses that method to\ndefine an implementation of ",(0,i.jsx)(n.code,{children:"AppHelper"})," in the service container. If you're\nnot yet familiar with Athenna service container, ",(0,i.jsx)(n.a,{href:"/docs/architecture-concepts/service-container",children:"check out its documentation"}),"."]}),"\n",(0,i.jsxs)(n.h3,{id:"the-boot-method",children:["The ",(0,i.jsx)(n.code,{children:"boot"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["So, what if we need to register a dependency that needs another dependency\nwithin our service provider? This should be done within the ",(0,i.jsx)(n.code,{children:"boot"})," method.\nThis method is called after all other service providers have been registered,\nmeaning you have access to all other services that have been registered by\nthe framework:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\nimport { AppHelper } from '#app/helpers/AppHelper'\n\nexport default class AppProvider extends ServiceProvider {\n public boot() {\n const appService = this.container.safeUse('App/Services/AppService')\n const appHelper = new AppHelper(appService)\n\n this.container.instance('App/Helpers/AppHelper', appHelper)\n }\n}\n"})}),"\n",(0,i.jsxs)(n.h3,{id:"the-shutdown-method",children:["The ",(0,i.jsx)(n.code,{children:"shutdown"})," method"]}),"\n",(0,i.jsxs)(n.p,{children:["The ",(0,i.jsx)(n.code,{children:"shutdown"})," method will be called when the application is going down for\nsome reason. This method is extremely useful for graceful shutdown the\napplication, and it's used in providers such as ",(0,i.jsx)(n.code,{children:"HttpServerProvider"})," and\n",(0,i.jsx)(n.code,{children:"DatabaseProvider"}),":"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\n\nexport default class AppProvider extends ServiceProvider {\n public async shutdown() {\n const appHelper = this.container.use('App/Helpers/AppHelper')\n\n if (!appHelper) {\n return\n }\n\n await appHelper.close()\n }\n}\n"})}),"\n",(0,i.jsx)(n.h2,{id:"registering-providers",children:"Registering providers"}),"\n",(0,i.jsxs)(n.p,{children:["All service providers are registered in the ",(0,i.jsx)(n.code,{children:".athennarc.json file"}),". This file\ncontains a ",(0,i.jsx)(n.code,{children:"providers"})," array where you can list the class names of your service\nproviders. By default, a set of Athenna core service providers are listed in\nthis array. These providers bootstrap the core Athenna components, such as\nthe http, route, services and others."]}),"\n",(0,i.jsxs)(n.p,{children:["If you are using the ",(0,i.jsx)(n.code,{children:"make:provider"})," command to create providers, Athenna\nwill automatically register the provider for you in this array, but if you\nmight need to register it manually, just add the path to it to the array:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-json",children:'{\n "providers": [\n // Other service providers...\n\n "#providers/AppProvider"\n ]\n}\n'})}),"\n",(0,i.jsx)(n.h2,{id:"choosing-applications",children:"Choosing applications"}),"\n",(0,i.jsxs)(n.p,{children:["In some cases you want that your provider only runs for a determined type of\nAthenna applications. For example, I have a ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," that connects\nwith some database if I don't have an Artisan command that do some work\ninside this database, why I would need to run this ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," when\nrunning Artisan application and commands?"]}),"\n",(0,i.jsxs)(n.p,{children:["To solve this problem you can use the ",(0,i.jsx)(n.code,{children:"environment"})," getter to choose the\napplications that could run this provider:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { ServiceProvider } from '@athenna/ioc'\n\nexport default class MockedDbProvider extends ServiceProvider {\n public get environment() {\n return ['http', 'repl']\n }\n}\n"})}),"\n",(0,i.jsxs)(n.p,{children:["Now when running Artisan application and commands, ",(0,i.jsx)(n.code,{children:"MockedDbProvider"})," will be\nignored."]}),"\n",(0,i.jsx)(n.p,{children:"The following environments are available by default in Athenna at this moment:"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"http"}),"\n",(0,i.jsx)(n.li,{children:"repl"}),"\n",(0,i.jsx)(n.li,{children:"console"}),"\n"]}),"\n",(0,i.jsxs)(n.p,{children:["You could also create your own environments. In your ",(0,i.jsx)(n.code,{children:"Path.bootstrap('main.ts')"})," file\nyou can add an ",(0,i.jsx)(n.code,{children:"environments"})," option when calling ",(0,i.jsx)(n.code,{children:"Ignite.load()"})," method:"]}),"\n",(0,i.jsx)(n.pre,{children:(0,i.jsx)(n.code,{className:"language-typescript",children:"import { Ignite } from '@athenna/core'\n\nconst ignite = await new Ignite().load(import.meta.url, {\n environments: ['myEnv']\n})\n\nawait ignite.httpServer()\n"})}),"\n",(0,i.jsxs)(n.p,{children:["All of your environments will be merged with Athenna default ones when running\nyour application. This means that in the example above, when running your\nhttp server, the providers bootstrapped will be only the ones that got the\nenvironments getter returning ",(0,i.jsx)(n.code,{children:"['*']"})," and ",(0,i.jsx)(n.code,{children:"['myEnv', 'http']"}),"."]})]})}function l(e={}){const{wrapper:n}={...(0,t.R)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},8453:(e,n,r)=>{r.d(n,{R:()=>s,x:()=>c});var i=r(6540);const t={},o=i.createContext(t);function s(e){const n=i.useContext(o);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function c(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(t):e.components||t:s(e.components),i.createElement(o.Provider,{value:n},e.children)}}}]);
\ No newline at end of file
diff --git a/assets/js/1169.b37bfd01.js b/assets/js/1169.b37bfd01.js
new file mode 100644
index 00000000..457415ab
--- /dev/null
+++ b/assets/js/1169.b37bfd01.js
@@ -0,0 +1 @@
+"use strict";(self.webpackChunk_athenna_docs=self.webpackChunk_athenna_docs||[]).push([[1169],{3046:(t,e,n)=>{n.d(e,{T:()=>k});var r=n(8585),o=n(9142),i=n(9610),s=n(7422),u=n(1662),c=n(6401),a=n(8058),f=n(9592),h=n(3588),A=n(4326),d=n(2062),l=n(5707);const v=function(t){return t!=t};const b=function(t,e,n){for(var r=n-1,o=t.length;++r