{"id":466,"date":"2024-09-26T16:55:05","date_gmt":"2024-09-26T09:55:05","guid":{"rendered":"https:\/\/gotutorial.org\/?page_id=466"},"modified":"2024-09-26T17:01:17","modified_gmt":"2024-09-26T10:01:17","slug":"go-packages","status":"publish","type":"page","link":"https:\/\/www.gotutorial.org\/go-tutorial\/go-packages\/","title":{"rendered":"Go Packages"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn about Go packages to organize code and make it reusable.<\/p>\n\n\n\n

Introduction to Go packages<\/h2>\n\n\n\n

In Go, a package is a collection of related source code files that are compiled together. Each package serves a single purpose<\/em>.<\/p>\n\n\n\n

Packages in Go are similar to modules or libraries in other programming languages.<\/p>\n\n\n\n

Every standalone Go program has at least one package called main<\/code>:<\/p>\n\n\n

package<\/span> main\n\nimport<\/span> \"fmt\"<\/span>\n\nvar<\/span> message = \"Hello, World!\"<\/span>\n\nfunc<\/span> say<\/span>(message string<\/span>)<\/span><\/span> {\n    fmt.Println(message)\n}\n\nfunc<\/span> main<\/span>()<\/span><\/span> {\n    say(message)\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
When you launch the program, Go runtime looks for the main()<\/code> function inside the main<\/code> package. Therefore, a Go program requires at least a main<\/code> package that includes the main()<\/code> function.<\/p>\n\n\n\n
Package scopes<\/h2>\n\n\n\n
In the above program, the main<\/code> package includes a message<\/code> variable, the say<\/code> and main<\/code> functions. These variables<\/a> and functions<\/a> are package scope.<\/p>\n\n\n\n
In Go,  identifiers such as variables and functions are either package or function scope. There is no “global” scope.<\/p>\n\n\n\n
In Go, you can declare anything at package scope. But you can’t use the short declaration operator :=<\/code>. For example, the following declaration results in a compilation error:<\/p>\n\n\n
package<\/span> main\n\nimport<\/span> \"fmt\"<\/span>\n\nmessage := \"Hello, World!\"<\/span> \/\/ ERROR<\/span>\n\n\/\/ ...<\/span><\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Package visibility<\/h2>\n\n\n\n
In Go, any capitalized name is automatically exported. This means that you can use it from other packages.<\/p>\n\n\n\n
For example, the Println<\/code> function from the fmt<\/code> package has the letter P<\/code> in uppercase, so you can use it in your package.<\/p>\n\n\n\n
On the other hand, any name that is not capitalized can be used only within the package.<\/p>\n\n\n\n
Importing packages<\/h2>\n\n\n\n
A package can import other necessary packages. Like variables, unused package imports will result in an error. To import a package, you use the import<\/code> statement followed by the package name:<\/p>\n\n\n
package<\/span> name<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
To import multiple packages, you place them within parentheses:<\/p>\n\n\n
import<\/span> (\n  \"fmt\"<\/span>\n  \"os\"<\/span>\n)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Go does not allow import cycles. For example, a package P<\/code> cannot import a package that imports P<\/code>. The following will result in an error:<\/p>\n\n\n\n
Package p<\/p>\n\n\n
package<\/span> p\n\nimport<\/span> \"q\"<\/span>\n\n\/\/ ...<\/span><\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
Package q:<\/p>\n\n\n
package<\/span> q\n\nimport<\/span> \"p\"<\/span>\n\n\/\/ ...<\/span><\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
To fix this import cycle, you need to move dependencies to a third package or eliminate them.<\/p>\n\n\n\n
Package init() function<\/h2>\n\n\n\n
The init()<\/code> function is a special function that the Go runtime will call automatically when the package is initialized.<\/p>\n\n\n\n
Typically, you use the init()<\/code> function to set up the initial state for the package before any other code within the package executes.<\/p>\n\n\n\n
Here are some key points of the init()<\/code> function:<\/p>\n\n\n\n
    \n
  • The init()<\/code> function takes no argument and doesn’t return any values.<\/li>\n\n\n\n
  • Each package can have multiple init()<\/code> functions. Go runtime will call them in the order they appear in the package.<\/li>\n\n\n\n
  • Go runtime calls the init()<\/code> function before<\/em> the main()<\/code> function in the main<\/code> package.<\/li>\n\n\n\n
  • Typically, you use the init()<\/code> function to initialize package-scoped variables, load the configuration files and establish a database connection.<\/li>\n<\/ul>\n\n\n\n
    The following example shows how to use the init()<\/code> function to create a log file with the name app.log<\/code> and set the log output to that file:<\/p>\n\n\n
    package<\/span> main\n\nimport<\/span> (\n    \"log\"<\/span>\n    \"os\"<\/span>\n)\n\nfunc<\/span> init<\/span>()<\/span><\/span> {\n    \/\/ Create a log file<\/span>\n    file, err := os.OpenFile(\"app.log\"<\/span>, os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666<\/span>)\n    if<\/span> err != nil<\/span> {\n        log.Fatalf(\"Failed to open log file: %v\"<\/span>, err)\n    }\n\n    \/\/ Set log output to the file<\/span>\n    log.SetOutput(file)\n}\nfunc<\/span> main<\/span>()<\/span><\/span> {\n    log.Println(\"This is a log message\"<\/span>)\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Go package example<\/h2>\n\n\n\n
    Step 1. Open your terminal and create a new directory to store the source code files:<\/p>\n\n\n
    mkdir myapp<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Step 2. Navigate to the project directory:<\/p>\n\n\n
    cd myapp<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Step 3. Initialize a Go module:<\/p>\n\n\n
    go<\/span> mod init myapp<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Step 4. Create a new directory for the greeting package:<\/p>\n\n\n
    mkdir greeting<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Step 5. Create a greeting.go<\/code> file inside the greeting package:<\/p>\n\n\n
    package<\/span> greeting\n\nimport<\/span> (\n    \"fmt\"<\/span>\n    \"time\"<\/span>\n)\n\nfunc<\/span> Greet<\/span>(name string<\/span>)<\/span> string<\/span><\/span> {\n    t := time.Now().Hour()\n    var<\/span> message string<\/span>\n    switch<\/span> {\n    case<\/span> t < 12<\/span>:\n        message = fmt.Sprintf(\"Good morning, %s\"<\/span>, name)\n    case<\/span> t < 17<\/span>:\n        message = fmt.Sprintf(\"Good afternoon, %s\"<\/span>, name)\n    default<\/span>:\n        message = fmt.Sprintf(\"Good evening, %s\"<\/span>, name)\n    }\n    return<\/span> message\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    The greeting<\/code> package has the Greet()<\/code> function that returns a greeting message to the person with the specified name.<\/p>\n\n\n\n
    Step 6. Call the Greet()<\/code> function from the greeting<\/code> package from the main()<\/code> function of the main<\/code> package:<\/p>\n\n\n
    package<\/span> main\n\nimport<\/span> (\n    \"fmt\"<\/span>\n    \"myapp\/greeting\"<\/span>\n)\n\nfunc<\/span> main<\/span>()<\/span><\/span> {\n    message := greeting.Greet(\"Joe\"<\/span>)\n    fmt.Println(message)\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    How it works.<\/p>\n\n\n\n
    First, import the fmt<\/code> and greeting<\/code> packages:<\/p>\n\n\n
    import<\/span> (\n    \"fmt\"<\/span>\n    \"myapp\/greeting\"<\/span>\n)<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Second, call the Greet()<\/code> method of the greeting package inside the main()<\/code> function<\/p>\n\n\n
    func<\/span> main<\/span>()<\/span><\/span> {\n    message := greeting.Greet(\"Joe\"<\/span>)\n    fmt.Println(message)\n}<\/code><\/span>Code language:<\/span> Go<\/span> (<\/span>go<\/span>)<\/span><\/small><\/pre>\n\n\n
    Summary<\/h2>\n\n\n\n
      \n
    • A package is a collection of related source code files compiled together.<\/li>\n\n\n\n
    • Go runtime calls init()<\/code> functions in the package first to set the initial state for the package.<\/li>\n\n\n\n
    • Go automatically exports names that are capitalized, so you can use them in other packages.<\/li>\n<\/ul>\n
      \n\t
      Was this tutorial helpful?<\/div>\n\t
      \n\t\t\n\t\t\t\n\t\t\t\t<\/path>\n\t\t\t<\/svg>\n\t\t\t Yes <\/span>\n\t\t<\/button>\n\n\t\t\n\t\t\t\n\t\t\t\t<\/path>\n\t\t\t<\/svg>\n\t\t\t No <\/span>\n\t\t<\/button>\n\t<\/div>\n\n\t
      \n\t\t
      \n\t\t\t
      <\/div>\n\t\t\t